Skip to navigation
Identity verification APIBiometric Authentication

Check whether a person can re-authenticate by face

Says whether face re-authentication can be offered for a person. It carries no personal details. An unknown reference, a business, and a person who is not enrolled all answer 200 with enrolled: false. Nothing is charged.

Error codes

errorStatusMeaning
environment_mismatch403The key belongs to an environment this deployment does not serve.
origin_not_allowed403The publishable key has an origin allowlist and the request origin is not on it.
ip_not_allowed403The secret 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.

Accepts a publishable (pk_) or secret (sk_) key.

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

externalUserIdstringRequired
Your reference for the person.

Response

The enrolment status.
enrolledboolean

Whether face re-authentication can be offered for this person. False for an unknown reference, a business, or a person with no enrolment.

enrolledAtdatetimeOptional
When the person was enrolled. Present only when enrolled.
lastAuthenticatedAtdatetime or nullOptional
When the person last authenticated. Present only when enrolled, and null if they never have.

Errors

401
Unauthorized Error
403
Forbidden Error