Read a version’s proof

Get the inclusion proof for a particular version under the current checkpoint.

GET/v1/identities/{n}/versions/{k}/proof

Access: Public; API key optional
Client: Browser fetch supported

Parameters#

Name	Location	Meaning
`n`Required	Path	Permanent positive card number.
`k`Required	Path	Positive published version number.

Request examples#

cURL

curl -fsS 'https://veil.rip/v1/identities/1/versions/1/proof'

javascript

const response = await fetch("https://veil.rip/v1/identities/1/versions/1/proof");
const result = await response.json();

Try the request#

Response#

HTTP 200application/json

The same proof object supplied with a full card, for version k.

Field	Type	Meaning
`version`	`integer`	Version covered by this proof.
`record`	`string`	Exact canonical JSON text that was signed. Do not reformat before verifying.
`salt`	`string`	Commitment salt in hex.
`serverSalt`	`string`	Server’s salt contribution in hex.
`clientSalt`	`string \| null`	Device’s salt contribution in hex, when used.
`commitment`	`string`	SHA-256 of salt bytes followed by record bytes, in hex.
`signedBy`	`string`	Public signing key.
`signature`	`string`	Signature over the identity-version prefix and exact record.
`entry`	`string`	Exact canonical log entry text.
`logIndex`	`integer`	Zero-based leaf index.
`leafHash`	`string`	SHA-256 of 0x00 followed by entry bytes, in hex.
`checkpoint`	`Checkpoint`	Signed checkpoint containing size, root and note.
`inclusion`	`array<string>`	Audit-path hashes in hex, deepest sibling first.
`witnesses`	`array<string>`	Witness cosignature lines also present in checkpoint.note.

Expand a nested object for its fields. Types ending in null allow a null value; optional fields may be absent. Other fields are present in that object.

Checkpoint Checkpoint

Field	Type	Meaning
`size`	`integer`	Number of leaves in the signed tree.
`root`	`string`	Root hash in base64.
`note`	`string`	Full signed note, including log and witness signatures.

Response headers#

Header	Value	Meaning
`Content-Type`	`application/json`	Use the declared media type before choosing a parser.
`Date`	`HTTP date`	Server time. Compare it with your clock when signing requests.
`Retry-After`	`integer seconds, on rate_limited or busy`	Wait at least this long before retrying. Other 429/503 codes do not necessarily include it.

What to verify#

Check the opening, leaf hash, inclusion and signed checkpoint.

Errors#

API errors return an error object. Use error.code for program logic; error.message is English text for people and can change. Response and error guide

HTTP	Code	Meaning and next step
400	`invalid_parameter`	A path, query or body field is missing, malformed or outside its accepted range. Correct the field named in `error.message` before sending again.
404	`not_found`	The requested card, key, alias, code or resource was not found. Check the identifier. Temporary codes and previews may already have expired or been used.
410	`erased`	The card existed and was erased or removed. The response also carries its public erasure receipt. Stop using this card as current authority. Retain only the public receipt if needed.
503	`log_unavailable`	The public log cannot currently be read, verified or used for publication. For reads, keep the result unverified and try later. Before retrying a write, read the card to check whether publication completed.

When using an optional API key

HTTP	Code	Meaning and next step
401	`invalid_api_key`	The bearer credential is malformed, unknown, expired or revoked. Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.
403	`api_key_scope`	The API key lacks read or verify scope, or the endpoint does not accept bearer keys. Use the correct scope. Identity writes and key management still require a device signature.
403	`api_key_suspended`	This API key is suspended. Ask staff to restore it; another key cannot lift an account suspension.
403	`developer_suspended`	The owner’s API account is suspended or the owner card is unavailable. Check the owner account and any staff restriction. Creating another key does not bypass suspension.

Shared request errors

HTTP Code Meaning and next step

429

HTTP	Code	Meaning and next step
429	`rate_limited`	An anonymous, signed-request or API-key allowance was exceeded. Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.
500	`internal_error`	An unexpected server error occurred. Internal details are not returned. Retry reads with bounded backoff. Check write results before sending a new signed operation.
503	`busy`	The application has reached a temporary concurrency or database limit. Wait `Retry-After` seconds and retry with bounded backoff.

rate_limited

An anonymous, signed-request or API-key allowance was exceeded.

Wait at least Retry-After seconds. Share a queue and retry budget across your workers.

500

internal_error

An unexpected server error occurred. Internal details are not returned.

Retry reads with bounded backoff. Check write results before sending a new signed operation.

503

busy

The application has reached a temporary concurrency or database limit.

Wait Retry-After seconds and retry with bounded backoff.

Read this entry as JSON