{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"notices-state","kind":"endpoint","group":"manage","title":"Read a card’s email notices","method":"GET","path":"/v1/identities/{n}/notices","paths":[],"summary":"An active key of the card reads its opt-in to email notices, with a signed GET.","response":"The card’s opt-in: whether it is on, the language, where the emails go and which events send one.","parameters":[{"name":"n","description":"Card number.","in":"path","required":true}],"sample":"/v1/identities/CARD_NUMBER/notices","access":"signed","base":"directory","notes":["Opting in needs a verified email link on the card. The notices go to its oldest verified address, one email per event, in plain text, with the card’s address, why it came and a stop link; at most 3 a card per UTC day, then a digest. Nothing signed changes."],"errors":["400 invalid_nonce","400 invalid_parameter","400 invalid_signature_alg","400 invalid_timestamp","401 invalid_signature","401 missing_signature","401 stale_timestamp","403 key_banned","403 key_mismatch","404 not_found","409 replayed_nonce","422 not_for_organizations","429 rate_limited","500 internal_error","503 busy"],"related":["signed-requests"],"sections":[{"kind":"code","language":"shell","code":"curl -fsS \\\n  -H \"X-Public-Key: $PUBLIC_KEY\" -H \"X-Signature: $REQUEST_SIGNATURE\" \\\n  -H \"X-Nonce: $NONCE\" -H \"X-Timestamp: $TIMESTAMP_MS\" \\\n  \"https://veil.rip/v1/identities/CARD_NUMBER/notices\""}],"live":false,"responses":[{"status":200,"contentType":"application/json","description":"The card’s opt-in: whether it is on, the language, where the emails go and which events send one.","fields":[{"name":"n","type":"integer","description":"Card number."},{"name":"on","type":"boolean","description":"Whether the card is opted in."},{"name":"lang","type":"string | null","description":"Language of the emails, en or it, when on."},{"name":"since","type":"string | null","description":"When the owner opted in."},{"name":"lastSentAt","type":"string | null","description":"When the last notice went."},{"name":"email","type":"string | null","description":"Where the emails go: the card’s oldest verified email address, read at sending time. Null without one."},{"name":"mail","type":"boolean","description":"Whether this server can send email at all."},{"name":"events","type":"array<string>","description":"The events a notice is sent for: takeover, device_added, device_revoked, backup_missing, proof_failing, key_idle, and canary_due for the owners of the Veil organisation."},{"name":"dailyCap","type":"integer","description":"Emails a card gets at most per UTC day; more notices go as one digest."}]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_nonce","description":"The signed-request nonce has an invalid format.","action":"Generate a fresh 16 to 128-character nonce using letters, digits, _ or -.","scope":"common"},{"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":"invalid_signature_alg","description":"`X-Signature-Alg` is unsupported.","action":"Use a supported signing algorithm and matching key/signature encoding.","scope":"common"},{"status":400,"code":"invalid_timestamp","description":"The signed-request timestamp is not Unix milliseconds.","action":"Use an integer Unix timestamp in milliseconds and sign the corrected request.","scope":"common"},{"status":401,"code":"invalid_signature","description":"The HTTP request signature does not verify.","action":"Sign the exact method, path and body bytes, without changing them afterwards.","scope":"common"},{"status":401,"code":"missing_signature","description":"The request requires a device signature and its headers are missing or unreadable.","action":"Send `X-Public-Key`, `X-Signature` and the signed-request metadata. An API key does not replace a device signature.","scope":"common"},{"status":401,"code":"stale_timestamp","description":"The signed timestamp is outside the accepted clock window.","action":"Compare the server Date header with your clock, then generate a fresh nonce, timestamp and signature.","scope":"common"},{"status":403,"code":"key_banned","description":"The device signing key is suspended by Veil staff.","action":"Use an authorised active key or ask staff to review the restriction.","scope":"common"},{"status":403,"code":"key_mismatch","description":"The signing key does not have authority over this card or operation.","action":"Use an active device key with the required owner or member role.","scope":"endpoint"},{"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":409,"code":"replayed_nonce","description":"The signing key already used this nonce.","action":"Check whether the previous request succeeded before making a fresh signed request.","scope":"common"},{"status":422,"code":"not_for_organizations","description":"Notices are for a person’s card. An organisation has none of its own.","action":"Each owner opts in on their own card.","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/notices-state","supportsBrowserFetch":false,"browserMode":"local-or-server"}}