Skip to navigation

Retrieve an identity check

Returns one identity check in full: what you submitted, the outcome, the details the check established and links to its photos. Poll this until status leaves pending.

Error codes

errorStatusMeaning
not_found404No identity check with that id, or it was deleted.
secret_key_required403A publishable key was used. This endpoint accepts secret keys only.
environment_mismatch403The key belongs to an environment this deployment does not serve.
ip_not_allowed403The key has an IP allowlist and the calling address is not on it.
organization_suspended403The organisation is suspended. The response carries reason and suspendedAt.
business_not_approved403A live key was used before the business was approved for production.

A missing or unknown key answers 401, where error is a short sentence rather than a code.

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 check id, as returned by the submit as verificationId.

Response

The identity check.
checkobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error