Biometric enrolment (v1)
Stable / GA
This is the current stable version of this step type.
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 | Description |
|---|---|---|---|
provider | string | No | Biometric enrolment provider. Currently only KEYLESS is supported. Accepted values: KEYLESS. |
Example configuration
{
"provider": "KEYLESS"
}
Input data blocks
| Data block | Required | Description |
|---|---|---|
UserReference | Conditional | Contains the unique subject identifier. Automatically generated from the subjectId provided in metadata at session creation. Present only when UserReference is available in the flow context. |
BiometricSamples | Conditional | An image source is required: BiometricSamples (priority) or DocumentImages. Present only when BiometricSamples is available in the flow context. |
DocumentImages | Conditional | An image source is required: BiometricSamples (priority) or DocumentImages. Present only when DocumentImages is available in the flow context. |
File size limit
Each file referenced in BiometricSamples or DocumentImages must not exceed 20 MB.
Routes
| Route | Description |
|---|---|
accepted | 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. |
Output data blocks
| Route | Data blocks produced |
|---|---|
accepted | AuthenticatorCredential |
rejected | — |
already_enrolled | — |