Enrollment
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
- Verification Initialization: Creates an authentication request and sends a UI directive to the client to start the biometric verification process.
This step involves capturing and registering a person’s biometric data so it can be used later to verify or identify them.
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
maxRetries | Integer | No | Defines the maximum number of retries the underlying service can attempt in case of a capture failure or image quality validation failure. If this option is not provided, a default value of 3 is applied. |
Input data blocks
Input requirements for this step.
| Data block | Mandatory | Description |
|---|---|---|
UserReference | Optional | Contains the unique subject identifier or the user alias (mail/tel etc). |
BiometricSamples or DocumentImages | Conditional | An image source is required: BiometricSamples (priority) or DocumentImages. |
Verdicts
Verdicts for this data block.
| Verdict | Description |
|---|---|
accepted | The enrollment was successful. |
rejected | The enrollment has failed after all retry attempts. |
already_enrolled | The user is already enrolled. |
Output data blocks
Data blocks produced per verdict.
| Scenario | Data blocks produced | Description |
|---|---|---|
| accepted | AuthenticatorCredential | The enrollment was successful. The authentication means has been created and is associated with the subject. A user identifier is generated by the node if the client does not provide a value (i.e., no DatablockType.UserReference provided as input). |
| rejected | ∅ | The enrollment has failed after all retry attempts. |
| already_enrolled | ∅ | The user is already enrolled. |