Read signed versions
Page through canonical records, signatures and openings.
/v1/identities/{n}/versions- Access
- Public; API key optional
- Client
- Browser fetch supported
Parameters#
| Name | Location | Meaning |
|---|---|---|
nRequired | Path | Permanent positive card number. |
after | Query | Version to continue after, 0 by default. |
limit | Query | 1 to 200. Default 50. |
latest | Query | true returns only the latest version. Cannot be combined with nonzero after. |
Request examples#
curl -fsS 'https://veil.rip/v1/identities/1/versions?latest=true&limit=1'const response = await fetch("https://veil.rip/v1/identities/1/versions?latest=true&limit=1");
const result = await response.json();Try the request#
Response#
versions is ordered oldest first. Follow next as the next after value until null. The byte budget can return fewer rows than limit.
| Field | Type | Meaning |
|---|---|---|
n | integer | Permanent card number. |
token | string | Stable log pseudonym. |
versions | array<VersionOpening> | Requested versions in ascending order. |
next | integer | null | Pass as after for the next page; null ends pagination. |
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.
Version opening VersionOpening
| Field | Type | Meaning |
|---|---|---|
version | integer | Version number. |
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 | null | Zero-based log index. |
logSize | integer | null | Tree size at publication. |
createdAt | string | Server creation time. |
publishedAt | string | null | Earliest cosignature time on the first checkpoint. |
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#
Recompute commitments, verify signatures and follow prev through the complete chain.
Usage notes#
- On a log in format 2 each item is a V2Version: label, body, signature, signedBy, logIndex, publishedAt and entry.
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 |
| 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. |
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 |
| 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 | rate_limited | An anonymous, signed-request or API-key allowance was exceeded. Wait at least |
| 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 |