Read the account-proof key
Read the public key used to sign account-linking grants.
/v1/grant-key- Access
- Public; API key optional
- Client
- Browser fetch supported
Request examples#
curl -fsS 'https://veil.rip/v1/grant-key'const response = await fetch("https://veil.rip/v1/grant-key");
const result = await response.json();Try the request#
Response#
alg, key, format and signingPrefix identify the grant signature format.
| Field | Type | Meaning |
|---|---|---|
alg | string | ed25519. |
key | string | Grant-signing public key in hex. |
format | string | veil-grant.v1. |
signingPrefix | string | Exact prefix included in the bytes to verify. |
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. |
What to verify#
A grant is an assertion by the directory about an account proof. Check its signature, scope and expiry. A grant alone does not publish a card version.
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
When using an optional API key
| HTTP | Code | Meaning and next step |
|---|---|---|
| 401 | invalid_api_key | The bearer credential is malformed, unknown, expired or revoked. Use an active key. To use anonymous public access, remove |
| 403 | api_key_scope | The API key lacks read or verify scope, or the endpoint does not accept bearer keys. Use the correct scope. Identity writes and key management still require a device signature. |
| 403 | api_key_suspended | This API key is suspended. Ask staff to restore it; another key cannot lift an account suspension. |
| 403 | developer_suspended | The owner’s API account is suspended or the owner card is unavailable. Check the owner account and any staff restriction. Creating another key does not bypass suspension. |
Shared request errors
| HTTP | Code | Meaning and next step |
|---|---|---|
| 429 | rate_limited | An anonymous, signed-request or API-key allowance was exceeded. Wait at least |
| 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 |