Enroll
This function enrolls a person according to the capture of their biometric data determined by the selected mode: face or voice. If the enrollment was successful, the function will return an enrollment ID. This enrollment ID can be compared with the one obtained in each authentication to verify that it was authenticated against the biometric data registered in the enrollment.
Parameter Configuration
This function requires you to configure the input parameters as described in the Input Registers table.
Function ID
Register | Value |
|---|---|
110 | 2 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
390 | Enrollment mode. | Yes | FACE, FACE_TEMPLATE, VOICE |
391 | Timeout in seconds. | No | Timeout in seconds. Default value: 30. |
392 | Set if user wants to extract biometric template. | No | 0 (no), 1 (yes). Default value: 0. |
393 | Biometric template to enroll with. It overrides any previous existent enroll. Available AND MANDATORY only for mode FACE_TEMPLATE. | Yes | - |
394 | Image Policy. Set callAPI behavior when no image with requested Face Angle Max Error was Found. | No | SOFT (returns random image and enrolls user). HARD (returns error and doesn't enroll user) Default value: SOFT. |
395 | Set liveness security level. | No | 1 (lower) to 5 (highest). Default: 0 - No liveness. |
396 | Output Image ID. Register ID where the user image will be saved. If not set, image won't be saved. | No | - |
397 | Face Angle Max Error. Max tolerable face angle rotation (in degrees) to accept a valid photo to take. | No | 0 to 360. Default value: 3. Recommendation: Don't use high values. |
Output Registers
Register | Description | Value | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||||||||||||||||||||||||||||||||
290 | Enrollment ID | ID for this enrollment. | ||||||||||||||||||||||||||||||||||||||||||||||||
291 | Enrollment biometric template | User's biometric base64 encoded. |
Note
Output image should be called using the Photo call API's functions Get Picture and Take Picture.