{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"card-badges","kind":"endpoint","group":"orgs","title":"Read a card’s badges","method":"GET","path":"/v1/identities/{n}/badges","paths":[],"summary":"Read a card’s badges and removed badge history.","response":"Badge information includes its public statement, current state and log references when applicable.","parameters":[{"name":"n","description":"Permanent positive card number.","in":"path","required":true}],"sample":"/v1/identities/1/badges","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/badges'"},{"kind":"code","language":"javascript","code":"const response = await fetch(\"https://veil.rip/v1/identities/1/badges\");\nconst result = await response.json();"}],"verify":"Check signed badge statements and their log commitments before using a badge as an authorisation condition.","live":true,"responses":[{"status":200,"contentType":"application/json","description":"Badge information includes its public statement, current state and log references when applicable.","fields":[{"name":"n","type":"integer","description":"Requested card number."},{"name":"badges","type":"array<object>","description":"Signed and derived badges, including removed or expired ones. Read active, derived and source before displaying a badge."}]}],"responseObjects":[{"id":"listed-badge","title":"Badge state","fields":[{"name":"id","type":"integer | null","description":"Signed badge ID, or null for a derived badge."},{"name":"badge","type":"string","description":"Catalogue badge identifier."},{"name":"active","type":"boolean","description":"Whether this badge currently applies."},{"name":"derived","type":"boolean","description":"Whether membership or the staff organisation generates it."},{"name":"source","type":"string","description":"statement, membership or staff_org."},{"name":"icon","type":"string","description":"Badge image URL."},{"name":"since","type":"string","description":"Start time."},{"name":"until","type":"string | null","description":"Expiry time, when limited."},{"name":"logIndex","type":"integer | null","description":"Issuance or membership log index."},{"name":"role","type":"string | null","description":"Issuing or membership role."},{"name":"removedAt","type":"string | null","description":"Removal time."},{"name":"removalLogIndex","type":"integer | null","description":"Log index of removal."}],"typeName":"ListedBadge"}],"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/card-badges","supportsBrowserFetch":true,"browserMode":"fetch"}}