Skip to navigation
Identity verification APISessions

Cancel a session or verification

Stops a session the applicant is part-way through, or a verification still being processed. The status becomes cancelled. While cancelled, the applicant cannot continue or start over. It can be reversed with uncancel.

Error codes

errorStatusMeaning
invalid_input400The reason is too long, or the body carries an unknown field.
not_found404No session or verification with that id for this organisation and environment.
verification_running409Its checks are running right now. Try again once they finish.
not_processing409There is nothing to cancel: the verification has finished or the session has ended.
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

sessionIdstringRequired
The session identifier. For cancel and uncancel, a verification identifier works too.

Request

This endpoint expects an object.
reasonstringOptional<=500 characters
Why. Kept internally and never sent to webhooks.

Response

The session or verification after the cancel.
idstring
The session or verification identifier.
kindenum

attempt for a session not yet submitted, verification for a submitted one.

Allowed values:
statusenum

The top-line status now.

previousStatusstring or null

The top-line status before the change, from the same vocabulary as status.

changedboolean
False when the call changed nothing, for example a repeat of an earlier cancel.
refundedboolean
Whether a reserved charge was released. A verification whose checks had begun is not refunded.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error