Skip to navigation
Identity verification APIBusiness Checks

Delete a business check

Removes a business check from your history. The delete is soft: the check leaves every list and read your organisation can reach. Nothing is refunded. The body is optional.

Error codes

errorStatusMeaning
invalid_input400The reason is longer than 500 characters.
not_found404No check with that id, or it was already deleted.
check_in_progress409The check is still running. Wait for its result before deleting it.
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.

Request

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

Response

The check was removed.
idstring
The id of the record that was removed.
deletedtrue
Always true on a successful delete.
deletedAtdatetime
When the record was removed.

Errors

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