Start an account proof
Begin OAuth, email, domain or Fediverse proof for a card you can manage.
/v1/links/start- Access
- Signed request
- Client
- Local or server client
JSON body#
| Name | Location | Meaning |
|---|---|---|
identityRequired | JSON | Permanent card number. |
platformRequired | JSON | A supported platform ID from /v1/platforms. |
subject | JSON | Required for email, domain and Fediverse. OAuth obtains it from the platform. |
method | JSON | Optional proof method. A domain supports dns_txt and well_known. |
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 -fsS -X POST \
-H "X-Public-Key: $PUBLIC_KEY" \
-H "X-Signature: $REQUEST_SIGNATURE" --json @request.json \
"https://veil.rip/v1/links/start"Response#
201 with state, method, expiresAt and challenge. Keep state private. Starting or completing a proof does not yet add the account to the card.
| Field | Type | Meaning |
|---|---|---|
state | string | Secret 64-character state. Keep it private. |
identity | integer | Target card number. |
platform | string | Platform identifier. |
method | string | Selected proof method. |
expiresAt | string | Proof-session expiry time. |
challenge | object | Method-specific instructions, such as an OAuth URL, DNS record or profile link. |
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. |
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 |
| 400 | invalid_parameter | A path, query or body field is missing, malformed or outside its accepted range. Correct the field named in |
| 403 | identity_banned | The acting identity is suspended by Veil staff. Wait for the restriction to end or ask staff to review it. |
| 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 | not_for_organizations | This proof method links a personal account and is unavailable to organisations. Choose a supported organisation proof method from /v1/platforms. |
| 422 | proof_failed | The provider, code or published proof did not verify. Read |
| 503 | mail_unavailable | The verification email could not be sent. Try starting the email proof again in a few minutes. |
| 503 | provider_not_configured | The selected proof provider is unavailable on this server. Read /v1/platforms for available methods. |
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 |
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 |
| 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 |
| 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 |