Skip to navigation

Get a verification result

Returns the full result, including the verified identity, the decision history and earlier attempts. result is present only when the checks passed; reason and reasonCode only when they did not.

Before the applicant submits, the same identifier returns the unsubmitted attempt, with data holding what they have entered so far. A workflow can withhold fields from this response through its returned-data settings.

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.
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.

Path parameters

idstringRequired
The verification identifier. A session identifier works too, because a verification keeps the identifier of its session.

Response

The verification result, or the unsubmitted attempt.
VerificationResultobject

The full result of a submitted verification. Fields may be withheld by the workflow returned-data settings.

OR
VerificationAttemptDataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error