Skip to main content
GET
Get verification document result

Authorizations

X-API-Key
string
header
required

Your workspace public key (pk_test_… or pk_live_…).

X-HMAC-Signature
string
header
required

HMAC-SHA256 of the request, hex-encoded, keyed with the workspace secret key. See API authentication.

Path Parameters

verification
string<uuid>
required

The verification ID

Response

Verification document result. type and gender are open enums: handle values not listed here. gender is F, M or X, where X means the document states that the sex is unspecified. other in type is a readable document that is not an identity card, passport, driving licence or residence permit, such as a health insurance card. Countries are ISO 3166-1 alpha-2 (XK for Kosovo). A document that prints only the month or year of expiry reports the last day of that period; a partially printed birth or issue date is null. On a Mexican voter card or driving licence created before 20 August 2026 17:00 UTC, gender is null. The German identity card prints no sex, so gender is null there. A permanent document (for example PERMANENTE or INDEFINIDA) reads as a null expiry_date. type id is the same value the upload endpoint takes. issuing_country and nationality can differ, for example on a residence permit. issuing_subdivision is the state or province that issued the document, as a bare code beside issuing_country (for example FL with US), or null; today it is filled for US driving licences and ID cards. place_of_birth is the printed text, not normalised. address is the printed text as read, not parsed and not normalised, and may contain line breaks.

document
object
required
media
object[]
required
meta
object
required