Skip to navigation
Identity verification APIBiometric Authentication

Redeem a biometric proof token

Redeems the proof token from a successful authentication, so your backend can trust a result that reached it through a browser or app. A token works once and for 30 minutes. Nothing is charged.

Error codes

errorStatusMeaning
invalid_request400The body failed validation.
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.
invalid_proof404The token is unknown, expired or already redeemed.

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.

Request

This endpoint expects an object.
tokenstringRequired1-128 characters
The proof token returned by a successful authentication.

Response

The proof was valid and is now spent.
validtrue

Always true. An invalid token answers 404 invalid_proof.

entityIdstring
The id of the person in your compliance records.
externalUserIdstring
Your reference for the person.
confidencedouble or null
The similarity score of the authentication, on a 0 to 100 scale.
authenticatedAtdatetime
When the authentication happened.

Errors

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