Skip to navigation
Identity verification APIVerifications

List verifications

Pages through your verification history, newest first, scoped to the key environment. Rows carry identifiers and states only; read one verification for its full result. Deleted records are not listed or counted.

Error codes

errorStatusMeaning
invalid_input400A filter was not text, a date was invalid, or from is after to.
invalid_status400status is not a known status.
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.

Query parameters

statusenumOptional

Return only verifications with this top-line status. A status only an unsubmitted session can hold returns an empty page.

channelenumOptional

Return only capture-flow verifications (sdk) or spot checks (dashboard).

Allowed values:
subjectTypeenumOptional
Return only individual or only business verifications.
Allowed values:
countrystringOptional

Return only verifications for this ISO 3166 alpha-2 country code.

idTypestringOptional
Return only verifications of this ID type or business lookup product.
workflowIdstringOptional
Return only verifications driven by this workflow.
externalUserIdstringOptional
Return only verifications carrying this reference of yours.
fromstringOptional

Return only verifications created on or after this date or date-time. Must begin YYYY-MM-DD.

tostringOptional

Return only verifications created on or before this date or date-time. Must begin YYYY-MM-DD.

pageintegerOptional>=1Defaults to 1
The page to return.
pageSizeintegerOptional1-100Defaults to 25
How many verifications per page.

Response

A page of verifications.
verificationslist of objects
The verifications on this page.
totalinteger
How many verifications match the filters.
pageinteger
The page returned.
pageSizeinteger
The page size applied.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error