Turn a card’s email notices on or off

An active key of the card opts in, with the language of the emails, or opts out. The body is {"on": true, "lang": "en" or "it"} or {"on": false}, with nonce and timestamp.

PUT/v1/identities/{n}/notices

Access: Signed request
Client: Local or server client

Parameters#

Name	Location	Meaning
`n`Required	Path	Card number.

This call also needs the common signed-request headers, nonce and timestamp. Prepare and sign request.json before using the example. Request signing

Request examples#

cURL

curl -fsS -X PUT \
  -H "X-Public-Key: $PUBLIC_KEY" \
  -H "X-Signature: $REQUEST_SIGNATURE" --json @request.json \
  "https://veil.rip/v1/identities/CARD_NUMBER/notices"

Response#

HTTP 200application/json

The card’s opt-in: whether it is on, the language, where the emails go and which events send one.

Field	Type	Meaning
`n`	`integer`	Card number.
`on`	`boolean`	Whether the card is opted in.
`lang`	`string \| null`	Language of the emails, en or it, when on.
`since`	`string \| null`	When the owner opted in.
`lastSentAt`	`string \| null`	When the last notice went.
`email`	`string \| null`	Where the emails go: the card’s oldest verified email address, read at sending time. Null without one.
`mail`	`boolean`	Whether this server can send email at all.
`events`	`array<string>`	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.
`dailyCap`	`integer`	Emails a card gets at most per UTC day; more notices go as one digest.

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.
`Retry-After`	`integer seconds, on rate_limited or busy`	Wait at least this long before retrying. Other 429/503 codes do not necessarily include it.

Usage 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.
Opting out deletes the opt-in and every notice waiting. Opting in again starts afresh.

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_json`	The body is not a JSON object, contains duplicate keys or has trailing data. Send one valid JSON object with `Content-Type` application/json.
400	`invalid_parameter`	A path, query or body field is missing, malformed or outside its accepted range. Correct the field named in `error.message` before sending again.
403	`key_mismatch`	The signing key does not have authority over this card or operation. Use an active device key with the required owner or member role.
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.
413	`payload_too_large`	The request body exceeds this endpoint’s byte limit. Reduce the encoded body. API-key management accepts at most 8 KiB.
422	`no_verified_email`	The card has no verified email link, so there is nowhere to send the notices. Link an email address to the card first, then opt in.
422	`not_for_organizations`	Notices are for a person’s card. An organisation has none of its own. Each owner opts in on their own card.
503	`no_mail_transport`	This server can’t send email. Nothing to retry: the server has no mail transport.

Shared request errors

HTTP	Code	Meaning and next step
400	`invalid_nonce`	The signed-request nonce has an invalid format. Generate a fresh 16 to 128-character nonce using letters, digits, _ or -.
400	`invalid_signature_alg`	`X-Signature-Alg` is unsupported. Use a supported signing algorithm and matching key/signature encoding.
400	`invalid_timestamp`	The signed-request timestamp is not Unix milliseconds. Use an integer Unix timestamp in milliseconds and sign the corrected request.
401	`invalid_signature`	The HTTP request signature does not verify. Sign the exact method, path and body bytes, without changing them afterwards.
401	`missing_signature`	The request requires a device signature and its headers are missing or unreadable. Send `X-Public-Key`, `X-Signature` and the signed-request metadata. An API key does not replace a device signature.
401	`stale_timestamp`	The signed timestamp is outside the accepted clock window. Compare the server Date header with your clock, then generate a fresh nonce, timestamp and signature.
403	`key_banned`	The device signing key is suspended by Veil staff. Use an authorised active key or ask staff to review the restriction.
409	`replayed_nonce`	The signing key already used this nonce. Check whether the previous request succeeded before making a fresh signed request.
429	`rate_limited`	An anonymous, signed-request or API-key allowance was exceeded. Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.
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 `Retry-After` seconds and retry with bounded backoff.

Read this entry as JSON