Biometric enrolment (v1)
Register a user’s facial biometric for future authentication or verifications
Used when customers want to activate facial recognition as a secure method for future authentication or identity verification.
Key features
- Enrolment Initialisation: Captures and registers the user’s biometric data so it can be used in future verifications.
This step involves capturing and registering a person’s biometric data so it can be used later to verify or identify them.
Configuration
| Option | Type | Required | Default | Description |
|---|---|---|---|---|
provider | "KEYLESS" | No | — | Biometric enrolment provider. Currently only KEYLESS is supported. |
Example configuration
{
"provider": "KEYLESS"
}
Input data blocks
| Data block | Required | Description |
|---|---|---|
UserReference | Optional | Contains the unique subject identifier. Automatically generated from the subjectId provided in metadata at session creation. |
BiometricSamples or DocumentImages | Conditional | An image source is required: BiometricSamples (priority) or DocumentImages. |
File size limit
Each file referenced in BiometricSamples or DocumentImages must not exceed 20 MB. Exceeding this limit returns HTTP 422 with error code FILE_TOO_LARGE at session creation.
Routes
| Route | Description |
|---|---|
accepted | The enrolment was successful. |
rejected | The enrolment has failed after all retry attempts. |
already_enrolled | The user is already enrolled. |
Output data blocks
| Route | Data blocks produced | Description |
|---|---|---|
| accepted | AuthenticatorCredential | The enrolment was successful. The authentication means has been created and is associated with the subject. |
| rejected | ∅ | The enrolment has failed after all retry attempts. |
| already_enrolled | ∅ | The user is already enrolled. |