{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"statements","kind":"endpoint","group":"history","title":"Read the chain of statements","method":"GET","path":"/v1/identities/{n}/statements","paths":[],"summary":"Page through a card's counted staff statements after the first page in index.statements.","response":"statements is ordered newest first. Follow statementsNext until it is null.","parameters":[{"name":"n","description":"Permanent positive card number.","in":"path","required":true},{"name":"from","description":"The log position to start from: prev of the last statement of the page before.","in":"query","required":true},{"name":"size","description":"The size of the checkpoint the card's index bundle is about: the inclusion proofs are in that tree.","in":"query","required":true}],"sample":"/v1/identities/1/statements?from=11&size=412","access":"public","base":"directory","notes":["Only on a log in format 2 (GET /v1/log says format 2). A log in format 1 answers 400 wrong_format."],"errors":["400 invalid_parameter","400 wrong_format","401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","404 not_found","429 rate_limited","500 internal_error","503 busy","503 log_unavailable"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/v1/identities/1/statements?from=11&size=412'"},{"kind":"code","language":"javascript","code":"const response = await fetch(\"https://veil.rip/v1/identities/1/statements?from=11&size=412\");\nconst result = await response.json();"}],"verify":"Each entry is included in the tree of size entries the card's checkpoint verified, is a statement about the card, and its prev is the i of the next one.","live":false,"responses":[{"status":200,"contentType":"application/json","description":"statements is ordered newest first. Follow statementsNext until it is null.","fields":[{"name":"n","type":"integer","description":"The card number."},{"name":"statements","type":"array<StatementEntry>","description":"Up to 200 statement entries, each with i, entry, inclusion and an optional by."},{"name":"statementsNext","type":"string | null","description":"The URL of the next page; null ends the chain."},{"name":"size","type":"integer","description":"The tree size of the inclusion proofs."}]}],"responseObjects":[{"id":"statement-entry","title":"Statement entry","typeName":"StatementEntry","fields":[{"name":"i","type":"integer","description":"The entry’s position in the log."},{"name":"entry","type":"string","description":"The entry text as the log holds it, signature included."},{"name":"inclusion","type":"array<string>","description":"Inclusion proof in hex, deepest sibling first, on the checkpoint of the card’s index bundle."},{"name":"by","type":"integer, optional","description":"Card number of the staff member who signed. A hint for display: the signer in the entry is what counts."}]}],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_parameter","description":"A path, query or body field is missing, malformed or outside its accepted range.","action":"Correct the field named in `error.message` before sending again.","scope":"endpoint"},{"status":400,"code":"wrong_format","description":"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.","action":"Read `format` in GET /v1/log (absent means 1) and send the shape of that format.","scope":"endpoint"},{"status":401,"code":"invalid_api_key","description":"The bearer credential is malformed, unknown, expired or revoked.","action":"Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.","scope":"optional-api-key"},{"status":403,"code":"api_key_scope","description":"The API key lacks read or verify scope, or the endpoint does not accept bearer keys.","action":"Use the correct scope. Identity writes and key management still require a device signature.","scope":"optional-api-key"},{"status":403,"code":"api_key_suspended","description":"This API key is suspended.","action":"Ask staff to restore it; another key cannot lift an account suspension.","scope":"optional-api-key"},{"status":403,"code":"developer_suspended","description":"The owner’s API account is suspended or the owner card is unavailable.","action":"Check the owner account and any staff restriction. Creating another key does not bypass suspension.","scope":"optional-api-key"},{"status":404,"code":"not_found","description":"The requested card, key, alias, code or resource was not found.","action":"Check the identifier. Temporary codes and previews may already have expired or been used.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"An anonymous, signed-request or API-key allowance was exceeded.","action":"Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.","scope":"common"},{"status":500,"code":"internal_error","description":"An unexpected server error occurred. Internal details are not returned.","action":"Retry reads with bounded backoff. Check write results before sending a new signed operation.","scope":"common"},{"status":503,"code":"busy","description":"The application has reached a temporary concurrency or database limit.","action":"Wait `Retry-After` seconds and retry with bounded backoff.","scope":"common"},{"status":503,"code":"log_unavailable","description":"The public log cannot currently be read, verified or used for publication.","action":"For reads, keep the result unverified and try later. Before retrying a write, read the card to check whether publication completed.","scope":"endpoint"}],"responseHeaders":[{"name":"Content-Type","value":"application/json","description":"Use the declared media type before choosing a parser."},{"name":"Date","value":"HTTP date","description":"Server time. Compare it with your clock when signing requests."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Wait at least this long before retrying. Other 429/503 codes do not necessarily include it."}],"documentationUrl":"https://veil.rip/docs/statements","supportsBrowserFetch":true,"browserMode":"fetch"}}