Skip to navigation
Identity verification APIVerifications

Get verification status

Returns the minimal state of a verification: no personal data, match scores or result fields. Before the applicant submits, the same identifier returns the unsubmitted attempt instead (its step and which captures are done).

reason and reasonCode are present whenever the checks did not pass, even when a reviewer later approved the verification. A hosted verification session token may read the status of its own verification.

Error codes

errorStatusMeaning
Verification not found404No verification or session with that id for this organisation and environment.
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.

Accepts a publishable (pk_) or secret (sk_) key.

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

verificationIdstringRequired
The verification or session identifier.

Response

The verification status, or the unsubmitted attempt.
VerificationStatusobject
The minimal state of a submitted verification. Carries no personal data.
OR
VerificationAttemptStatusobject
A session that has not been submitted yet. Returned for the same identifier until the applicant submits.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error