Skip to navigation
Identity verification APIVerifications

Delete a verification

Removes a finished verification, or a session that was never submitted, from every surface your organisation can read. Nothing is refunded. A deleted record cannot be restored through the API; contact support if one was deleted by mistake.

Error codes

errorStatusMeaning
invalid_input400The reason is longer than 500 characters.
verification_not_found404No record with that id, or it is already deleted.
verification_in_progress409The checks are still running. Wait for the result.
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.

Request

This endpoint expects an object.
reasonstringOptional<=500 characters
Why the record is being deleted. Kept in your audit log and never sent to webhooks.

Response

The record was deleted.
verificationIdstring
The identifier of the deleted record.
kindenum

verification for a submitted record, attempt for a session that was never submitted.

Allowed values:
deletedboolean
Always true.
deletedAtdatetime
When the record was deleted.

Errors

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