Read one statement
One signed statement by its id, with its card and, for a retraction, the statement it retracts. /statements/{id} is its page, with a preview and an Article in JSON-LD; add .json for this JSON.
/v1/statements/{id}- Access
- Public; API key optional
- Client
- Browser fetch supported
Other addresses#
/statements/{id}
Parameters#
| Name | Location | Meaning |
|---|---|---|
idRequired | Path | The statement’s id: its position in the log. |
Request examples#
curl -fsS 'https://veil.rip/v1/statements/1'Response#
The statement.
| Field | Type | Meaning |
|---|---|---|
card | object | n, type, name, token and url of the card. |
statement | object | The statement, as in the card’s list. |
retracts | object | null | For a retraction, the statement it retracts. |
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. |
Cache-Control | no-cache | Ask again each time: a new statement or alert shows at once. |
What to verify#
Check each item before you show it as the card’s: canonical statement, c = SHA-256(salt ‖ statement), the entry’s signature over "veil-rubrica:card-entry:v2\n" and the entry without signature, with a key active for the signer at position i (from the signer’s authority versions), and the inclusion in a checkpoint signed by the log and cosigned by a quorum. The list itself is the server’s word: it can leave out an 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 |
| 400 | wrong_format | The request or the read belongs to the other log format than this server’s: a v1 record on a format 2 log, or a format 2 read on a format 1 log. Read |
| 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. |
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 |