Skip to navigation
Identity verification APIMedia

Download captured media

Streams one image, video or document captured for a verification. These are the URLs delivered in the media object of verification webhooks. The response honours the Range header, and sends an ETag so a repeat request with If-None-Match can be answered 304.

Fixed kinds: selfie, document-front, document-back, liveness-video, document-front-video, document-back-video, proof-of-address, address-photo, address-street-view, chip-signature, chip-portrait, auth-reference, document-portrait, record-photo, silent-capture-1, silent-capture-2, silent-capture-3.

Numbered families: id-check-<n>-front, -back, -front-video, -back-video, -photo and -portrait for check n (1 to 3) of a multiple-ID verification; supporting-document-<n> (1 to 8); business-document-<n> (1 to 8).

Sandbox media is replaced by a placeholder after three days: an SVG image for image kinds, and a 302 redirect to a sample clip for video kinds.

Error codes

errorStatusMeaning
Invalid media kind400The kind is not one this endpoint serves.
Verification not found404No verification with that id for this organisation and environment.
Media not found404The verification holds no file of that kind.
Missing or invalid Authorization header401No bearer credential was sent.
Invalid API key401The key is unknown or revoked.
environment_mismatch403The key belongs to an environment this host does not serve.
origin_not_allowed403The request origin is not on the publishable key allowlist.
ip_not_allowed403The caller address is not on the secret key allowlist.
organization_suspended403The organisation is suspended.
secret_key_required403A publishable key was used on a secret-key endpoint.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Path parameters

idstringRequired
The verification identifier.
kindenum or stringRequired
Which captured file to return. One of the fixed kinds, or a member of a numbered family.

Response

The file, with its own Content-Type.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error