Authentication (v1)
BIOMETRIC_VERIFICATION:v2 is in preview
BIOMETRIC_VERIFICATION:v2 introduces a unified Verification data block but its implementation is not yet finalized. Use BIOMETRIC_VERIFICATION:v1 for all production flows.
Authenticates identity using facial recognition
Used when strong, real‑time identity confirmation is required. The user completes a quick face scan, and the system ensures they are a real person and match the enrolled face, helping prevent impersonation, spoofing, and deepfakes.
Key features
- Liveness detection: Confirms the user is physically present and not a spoof or replay attack.
- Face comparison: Matches the live capture against the enrolled biometric template.
- Evidence preservation: On success, the authentication result is recorded in the
AuthenticationResultdatablock for audit purposes.
This step requires previous enrollment via the Biometric Enrollment step and uses the captured biometric data to authenticate the user.
Configuration
| Option | Type | Required | Default | Description |
|---|---|---|---|---|
provider | "KEYLESS" | No | — | Biometric verification provider. Currently KEYLESS is the only supported value and is used regardless of this field. |
enableRetry | boolean | No | false | When enabled, adds a retry route for user cancellation. |
Input data blocks
| Data block | Required | Description |
|---|---|---|
UserReference | Yes | Contains the unique subject identifier (subjectId) necessary to identify the user in the Keyless system. |
Routes
| Route | Description |
|---|---|
authenticated | Biometric authentication succeeded. The user has been successfully authenticated. |
failed | Biometric authentication failed. This can be due to biometric mismatch, capture error, or technical issue. |
retry | Available when enableRetry: true. User cancelled and can retry. |
Output data blocks
| Route | Data blocks produced | Description |
|---|---|---|
| authenticated | AuthenticationResult | Biometric authentication succeeded. The user has been successfully authenticated. |
| failed | AuthenticationResult | Biometric authentication failed. This can be due to biometric mismatch, capture error, or technical issue. |
| retry | AuthenticationResult | User cancelled and can retry. Available when enableRetry: true. |
The AuthenticationResult data block is a discriminated union with a result field containing either success or failure details. Refer to the data blocks reference for the full structure.