{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"create-api-key","kind":"endpoint","group":"developer","title":"Create an integration key","method":"POST","path":"/v1/developer/accounts/{n}/keys","paths":[],"summary":"A person or organisation owner signs the request to issue a secret bearer key.","response":"201 with key metadata and secret. The secret is returned only here and cannot be retrieved again.","parameters":[{"name":"n","in":"path","required":true,"description":"Permanent number of the person or organisation that owns the allowance."}],"sample":"/v1/developer/accounts/1/keys","access":"signed","base":"directory","notes":["The owner signs with an active device key. Organisation management requires an accepted owner. Bearer API keys cannot authorise this call.","The response is private and uses Cache-Control no-store.","Management writes accept at most 8 KiB and reject unknown body fields. nonce and timestamp are the common signing fields."],"errors":["400 invalid_json","400 invalid_nonce","400 invalid_parameter","400 invalid_signature_alg","400 invalid_timestamp","401 invalid_signature","401 missing_signature","401 stale_timestamp","403 developer_suspended","403 identity_banned","403 key_banned","403 key_mismatch","404 not_found","409 api_key_limit","409 replayed_nonce","413 payload_too_large","429 rate_limited","500 internal_error","503 busy"],"related":["api-keys"],"sections":[{"kind":"code","language":"shell","code":"curl -fsS -X POST \\\n  -H \"X-Public-Key: $PUBLIC_KEY\" -H \"X-Signature: $REQUEST_SIGNATURE\" \\\n  --json @request.json \"https://veil.rip/v1/developer/accounts/1/keys\""}],"live":false,"bodyFields":[{"name":"label","in":"body","required":true,"description":"Integration label, 1 through 60 characters."},{"name":"scopes","in":"body","required":false,"description":"Array containing read and/or verify. Both are enabled by default."},{"name":"expiresInDays","in":"body","required":false,"description":"1 through 365, default 90."}],"responses":[{"status":201,"contentType":"application/json","description":"201 with key metadata and secret. The secret is returned only here and cannot be retrieved again.","fields":[{"name":"key","type":"ApiKey","description":"Created key metadata."},{"name":"secret","type":"string","description":"One-time bearer credential. Save it now; no later response can retrieve it."}],"example":{"language":"json","code":"{\n  \"key\": {\n    \"id\": \"0123456789abcdef0123456789abcdef\",\n    \"owner\": 1,\n    \"label\": \"Website backend\",\n    \"prefix\": \"veil_live_01234567…\",\n    \"scopes\": [\n      \"read\",\n      \"verify\"\n    ],\n    \"state\": \"active\",\n    \"createdAt\": \"2026-10-27T00:00:00Z\",\n    \"expiresAt\": \"2027-01-25T00:00:00Z\",\n    \"revokedAt\": null,\n    \"suspended\": false,\n    \"requestsPerMinute\": null,\n    \"lastUsedAt\": null,\n    \"requests\": 0\n  },\n  \"secret\": \"<save-the-one-time-secret-here>\"\n}"}}],"responseObjects":[{"id":"api-key","title":"API key metadata","fields":[{"name":"id","type":"string","description":"Public key-management ID, not the bearer secret."},{"name":"owner","type":"integer","description":"Permanent owner card number."},{"name":"label","type":"string","description":"Integration label supplied by its owner."},{"name":"prefix","type":"string","description":"Non-secret display prefix."},{"name":"scopes","type":"array<string>","description":"read and/or verify."},{"name":"state","type":"string","description":"active, expired, suspended or revoked. Account suspension is reported separately."},{"name":"createdAt","type":"string","description":"Creation time in ISO 8601 UTC."},{"name":"expiresAt","type":"string","description":"Expiry time in ISO 8601 UTC."},{"name":"revokedAt","type":"string | null","description":"Permanent revocation time."},{"name":"suspended","type":"boolean","description":"Whether this key is suspended."},{"name":"requestsPerMinute","type":"integer | null","description":"Additional per-key cap, or null."},{"name":"lastUsedAt","type":"string | null","description":"Last admitted use, or null if never used."},{"name":"requests","type":"integer","description":"Lifetime admitted requests for this key."}],"typeName":"ApiKey"}],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_json","description":"The body is not a JSON object, contains duplicate keys or has trailing data.","action":"Send one valid JSON object with `Content-Type` application/json.","scope":"endpoint"},{"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":"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":"endpoint"},{"status":403,"code":"identity_banned","description":"The acting identity is suspended by Veil staff.","action":"Wait for the restriction to end or ask staff to review it.","scope":"endpoint"},{"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":"api_key_limit","description":"The owner already has 20 unexpired, unrevoked API keys.","action":"Revoke an unused key before creating another. Suspended keys still count.","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":413,"code":"payload_too_large","description":"The request body exceeds this endpoint’s byte limit.","action":"Reduce the encoded body. API-key management accepts at most 8 KiB.","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":"Cache-Control","value":"no-store","description":"Do not persist private or temporary responses in a shared cache."},{"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/create-api-key","supportsBrowserFetch":false,"browserMode":"local-or-server"}}