Skip to navigation
Identity verification APIFace Match

Delete a face check

Removes a face 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 face check with that id, or it was already deleted.
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 face check id, as returned by the comparison or the history list.

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