verify

Check a verify code or a signed result

Check a verify code (from a document or a /verify/<code> link) or an API result's signature.jws. Says whether Tektolo issued it, which tool, ruleset and engine it used, when, and whether that ruleset is still current. With text, also whether a summary is word for word the one its code was issued for. Nothing is stored.

post/v1/verify

Request

  • Base URL: https://tektolo.com (the document declares no server; this is the origin it was published from)
  • URL: https://tektolo.com/v1/verify
  • Auth: none declared

Request body

codestring nullable

A verify code, or a whole verify link (…/verify/<code>).

textstring nullable

Optional, for a summary's code: the summary's text, to check it was not changed. Compared in memory and not stored.

jwsstring nullable

Instead of a code: an API result's signature.jws, to check its signature.

Response

Successful Response

signing'on' | 'off' required
verifiedboolean required

True only when Tektolo's signature checks out.

reasonstring required

Empty when verified; else malformed, unsupported, unknown_key, bad_signature or signing_off.

messagestring required
kidstring nullable
issued_onstring nullable

The day it was issued (UTC).

issued_atstring nullable

JWS only: the exact time.

capabilitystring nullable
capability_namestring nullable
tool_namestring nullable

The web tool's name when a web tool issued it.

operationstring nullable
documentstring nullable

What the code was printed on.

result_hashstring nullable

JWS only.

covers'result' | 'text' nullable

What the code's keyed digest covers: one result, or a summary's text.

text_check'not_asked' | 'matches' | 'differs' | 'not_available' nullable
text_messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.