Skip to navigation
Identity verification APIContact Verification

Retrieve a contact verification

Returns a challenge at any point in its life. Use it to reconcile your own state after a dropped response.

Error codes

errorStatusMeaning
challenge_not_found404No challenge with that id for this organisation and environment, or it was not created through this API.
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 contact verification id returned when the code was sent.

Response

The contact verification.
contactVerificationobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error