Read a card’s moderation state
Read the public status and moderation actions affecting a card.
/v1/identities/{n}/moderation- Access
- Public; API key optional
- Client
- Browser fetch supported
Parameters#
| Name | Location | Meaning |
|---|---|---|
nRequired | Path | Permanent positive card number. |
Request examples#
curl -fsS 'https://veil.rip/v1/identities/1/moderation'const response = await fetch("https://veil.rip/v1/identities/1/moderation");
const result = await response.json();Try the request#
Response#
Current status, public actions, categories, times, commitments and log indices. Private reasons, evidence and actor names are omitted.
| Field | Type | Meaning |
|---|---|---|
n | integer | Requested card number. |
banned | boolean | Whether an identity ban is in force. |
until | string | null | Ban expiry time. |
category | string | null | Public ban category. |
logIndex | integer | null | Log index of the ban. |
actions | array<object> | Public actions with id, action, category, time, publishedAt, until, key, logIndex, commitment, actor, revertedBy and reverts. Private reasons and evidence are excluded. |
nameHidden | object | null | category, since and logIndex of a hidden name. |
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#
Match each commitment and logIndex to the public log entry.
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_parameter | A path, query or body field is missing, malformed or outside its accepted range. Correct the field named in |
| 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. |
| 410 | erased | The card existed and was erased or removed. The response also carries its public erasure receipt. Stop using this card as current authority. Retain only the public receipt if needed. |
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 |