{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"aliases","kind":"endpoint","group":"cards","title":"Resolve or check an alias","method":"GET","path":"/v1/aliases/{kind}/{alias}","paths":[],"summary":"Check availability and find the permanent card behind a claimed alias.","response":"available and status describe the alias. Claimed aliases include identity. quarantineDays and reusableAt describe a released name. reservedFor may identify a reserved organisation.","parameters":[{"name":"kind","description":"u for people, o for organisations.","in":"path","required":true},{"name":"alias","description":"3 to 32 ASCII letters, digits, hyphens or underscores. Starts with a letter and ends with a letter or digit.","in":"path","required":true}],"sample":"/v1/aliases/o/veil","access":"public","base":"directory","notes":["Availability does not reserve a name. Claiming an alias uses a signed version. Store the permanent number because names can be released and reassigned."],"errors":["400 invalid_alias","400 invalid_parameter","401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/v1/aliases/o/veil'"},{"kind":"code","language":"javascript","code":"const response = await fetch(\"https://veil.rip/v1/aliases/o/veil\");\nconst result = await response.json();"}],"live":true,"responses":[{"status":200,"contentType":"application/json","description":"available and status describe the alias. Claimed aliases include identity. quarantineDays and `reusableAt` describe a released name. reservedFor may identify a reserved organisation.","fields":[{"name":"kind","type":"string","description":"u for a person, o for an organisation."},{"name":"alias","type":"string","description":"Normalised alias."},{"name":"available","type":"boolean","description":"Whether a new claim can proceed now."},{"name":"status","type":"string","description":"available, claimed, reserved_name, publishing or quarantined."},{"name":"url","type":"string","description":"Alias address being checked."},{"name":"identity","type":"object | null","description":"Current holder’s n and permanent url."},{"name":"reusableAt","type":"string | null","description":"Quarantine end time."},{"name":"quarantineDays","type":"integer","description":"Quarantine duration, currently 30 days."},{"name":"previousIdentity","type":"object | null","description":"Previous holder when disclosed for quarantine."},{"name":"reservedFor","type":"object | null","description":"Card allowed to reclaim a reserved alias, when applicable."}],"example":{"language":"json","code":"{\n  \"kind\": \"u\",\n  \"alias\": \"sample-person\",\n  \"available\": true,\n  \"status\": \"available\",\n  \"url\": \"https://veil.rip/u/sample-person\",\n  \"identity\": null,\n  \"reusableAt\": null,\n  \"quarantineDays\": 30,\n  \"previousIdentity\": null,\n  \"reservedFor\": null\n}"}}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_alias","description":"The alias does not meet the ASCII name rules.","action":"Use 3 to 32 lowercase ASCII letters, digits, hyphens or underscores; start with a letter and end with a letter or digit.","scope":"endpoint"},{"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":401,"code":"invalid_api_key","description":"The bearer credential is malformed, unknown, expired or revoked.","action":"Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.","scope":"optional-api-key"},{"status":403,"code":"api_key_scope","description":"The API key lacks read or verify scope, or the endpoint does not accept bearer keys.","action":"Use the correct scope. Identity writes and key management still require a device signature.","scope":"optional-api-key"},{"status":403,"code":"api_key_suspended","description":"This API key is suspended.","action":"Ask staff to restore it; another key cannot lift an account suspension.","scope":"optional-api-key"},{"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":"optional-api-key"},{"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":"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/aliases","supportsBrowserFetch":true,"browserMode":"fetch"}}