Skip to navigation
Identity verification APIEntity Actions

Enrol an entity for face re-authentication

Enrols an existing verified individual for face re-authentication, using the selfie from the verification that created the entity. The request takes no body. Repeating the call refreshes the same enrolment rather than creating another, and it also reactivates an enrolment that was revoked.

Most entities are enrolled automatically when their verification completes; use this call to enrol one that was not. The call is recorded in your audit log.

Error codes

errorStatusMeaning
entity_not_found404No live entity has this reference in this organisation and environment.
entity_not_individual422The entity is a business. Only individuals can be enrolled.
no_selfie409The entity has no verification with a usable selfie to enrol from.
secret_key_required403A publishable key was used. This API accepts secret keys only.
environment_mismatch403The key belongs to an environment this host does not serve.
rate_limited429The request rate limit for this key was reached. Retry after a short wait.
rate_limit_store_unavailable503Rate limiting is temporarily unavailable. Retry shortly.

A missing or unknown key returns 401 with a plain sentence in error 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

externalUserIdstringRequired
Your own stable reference for the person or business, as sent when the entity was registered.

Response

The entity is enrolled.
enrolledboolean
Always true.
entityIdstring
The Toden identifier of the enrolled entity.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error