veil

Read a published logo or photo

Read the image currently published on a person’s or organisation’s card.

GET/{kind}/{n}/logo.{format}
Access
Public; API key optional
Client
Browser fetch supported

Parameters#

NameLocationMeaning
kindRequiredPathu or o.
nRequiredPathPermanent positive card number.
formatRequiredPathsvg, png or gif. Use the card’s logo.url.
vQueryCurrent image hash from logo.url. A matching value allows one day of public caching.
sizeQueryPNG only, 64 or 128. Request a proportional display thumbnail when it saves bytes. Small PNGs and animated APNGs keep their original bytes. Omit for the exact published image.

Request examples#

cURL
curl -fsS 'https://veil.rip/o/2/logo.svg'

Response#

HTTP 200image/svg+xml | image/png | image/gif

The exact published SVG, PNG or GIF when size is omitted. With size=64 or size=128 on a PNG, a smaller display derivative may be returned. Missing or hidden images return 404.

Response headers#

HeaderValueMeaning
Content-Typeimage/svg+xml | image/png | image/gifUse the declared media type before choosing a parser.
DateHTTP dateServer time. Compare it with your clock when signing requests.
Cache-Controlno-cache or public, max-age=86400A v query matching the current hash prefix permits one day of caching.
Retry-Afterinteger seconds, on rate_limited or busyWait at least this long before retrying. Other 429/503 codes do not necessarily include it.

Usage notes#

  • These image routes use the permanent number. Unpublished preview images have different access requirements.
  • The response is an image, not JSON. Use it in an img element or read the bytes with response.blob().
  • Thumbnails are for display. Verify the original image bytes in the signed record. SVG, GIF and APNG animation remain available unchanged; size on SVG/GIF or any value other than 64/128 returns 400 invalid_parameter. Current visibility and the v hash are checked before serving a derivative.

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

HTTPCodeMeaning and next step
400invalid_parameter

A path, query or body field is missing, malformed or outside its accepted range.

Correct the field named in error.message before sending again.

404not_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.

410erased

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.

422not_a_person

The card is an organisation where a person is required.

Use the organisation endpoint or an eligible person’s card.

422not_an_organization

The card is a person where an organisation is required.

Use the person endpoint or an organisation card.

When using an optional API key
HTTPCodeMeaning and next step
401invalid_api_key

The bearer credential is malformed, unknown, expired or revoked.

Use an active key. To use anonymous public access, remove Authorization entirely. Invalid credentials never fall back automatically.

403api_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.

403api_key_suspended

This API key is suspended.

Ask staff to restore it; another key cannot lift an account suspension.

403developer_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
HTTPCodeMeaning and next step
429rate_limited

An anonymous, signed-request or API-key allowance was exceeded.

Wait at least Retry-After seconds. Share a queue and retry budget across your workers.

500internal_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.

503busy

The application has reached a temporary concurrency or database limit.

Wait Retry-After seconds and retry with bounded backoff.