{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"summary","kind":"endpoint","group":"cards","title":"Read a small card summary","method":"GET","path":"/v1/identities/{n}/summary","paths":[],"summary":"Get current metadata without downloading signed records, proofs or history.","response":"n, url, name, initials, type, version, keys, orgs, badges, nameHidden and logo. Useful for labels and menus.","parameters":[{"name":"n","description":"Permanent positive card number.","in":"path","required":true}],"sample":"/v1/identities/1/summary","access":"public","base":"directory","notes":[],"errors":["400 invalid_parameter","401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","404 not_found","410 erased","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/v1/identities/1/summary'"},{"kind":"code","language":"javascript","code":"const response = await fetch(\"https://veil.rip/v1/identities/1/summary\");\nconst result = await response.json();"}],"verify":"Use the full card for verification or an authorisation decision.","live":true,"responses":[{"status":200,"contentType":"application/json","description":"n, url, name, initials, type, version, keys, orgs, badges, nameHidden and logo. Useful for labels and menus.","fields":[{"name":"n","type":"integer","description":"Permanent card number."},{"name":"url","type":"string","description":"Permanent URL using the card number."},{"name":"name","type":"string","description":"Current display name; a hidden name becomes Card followed by its number."},{"name":"initials","type":"string","description":"Initials for an image fallback."},{"name":"version","type":"integer","description":"Current published version."},{"name":"keys","type":"array<CardKey>","description":"All device and recovery keys, including revoked keys."},{"name":"orgs","type":"array<CardOrg>","description":"Accepted organisation affiliations of a person."},{"name":"type","type":"string","description":"person or organization."},{"name":"badges","type":"array<object>","description":"Active signed or derived badges."},{"name":"logo","type":"object | null","description":"Image type and URL; omitted without a visible image."},{"name":"alias","type":"string | null","description":"Current alias; it can change."},{"name":"aliasUrl","type":"string | null","description":"Current alias address. Use n as the permanent identifier."},{"name":"nameHidden","type":"boolean","description":"Whether staff hide the name."}]}],"responseObjects":[{"id":"card-key","title":"Device key","fields":[{"name":"id","type":"string","description":"Device label shown on the card."},{"name":"alg","type":"string","description":"Readable algorithm name."},{"name":"fp","type":"string","description":"Full public key as stored in the signed record."},{"name":"ed25519","type":"string","description":"Ed25519 key or composite-key half, in hex."},{"name":"since","type":"string","description":"Date the key was added."},{"name":"state","type":"string","description":"active, offline or revoked. Offline denotes a recovery key."},{"name":"revoked","type":"string | null","description":"Revocation date, when revoked."},{"name":"role","type":"string","description":"Signing role assigned to the key."},{"name":"addedIn","type":"integer","description":"Version that added the key."},{"name":"revokedIn","type":"integer | null","description":"Version that revoked the key."}],"typeName":"CardKey"},{"id":"card-org","title":"Organisation affiliation","fields":[{"name":"n","type":"integer","description":"Permanent card number."},{"name":"url","type":"string","description":"Permanent card URL."},{"name":"name","type":"string","description":"Display name, subject to moderation."},{"name":"role","type":"string","description":"Accepted membership role."},{"name":"since","type":"string","description":"Membership start time."},{"name":"nameHidden","type":"boolean","description":"Whether staff hide the name."},{"name":"logo","type":"object | null","description":"Image type and URL, when available."}],"typeName":"CardOrg"}],"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":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":410,"code":"erased","description":"The card existed and was erased or removed. The response also carries its public erasure receipt.","action":"Stop using this card as current authority. Retain only the public receipt if needed.","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"}],"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/summary","supportsBrowserFetch":true,"browserMode":"fetch"}}