Skip to main content

Veritran Docs

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

000

API_NO_ERROR

001

API_WRONG_PARAMETERS_ERROR

010

API_GENERIC_ERROR

020

ERR_CUSTOM_API_NOT_IMPLEMENTED

021

ERR_CUSTOM_API_WRONG_OUTPUT_PARAMETERS

100

ERR_INVALID_MODE

101

ERR_STATUS_NOT_OS_SUPPORTED

102

ERR_STATUS_NO_FRONT_CAMERA

103

ERR_STATUS_EXPIRED_LICENSE

104

ERR_MODE_NOT_SUPPORTED

105

ERR_USER_ALREADY_ENROLLED

106

ERR_STATUS_PERMISSION_NOT_ALLOWED

108

ERR_INVALID_TIMEOUT_PARAMETER

111

ERROR_EXIT_REASON_TIMED_OUT

112

ERROR_EXIT_REASON_ABORTED

113

ERROR_EXIT_REASON_NO_ENROLLMENT

114

ERROR_EXIT_REASON_ERROR

115

ERROR_EXIT_REASON_GENERIC_ERROR

116

ERROR_INVALID_MODE_OBTAINED

117

ERROR_INVALID_TEMPLATE

118

ERROR_CANT_EXTRACT_TEMPLATE

119

ERROR_INVALID_LIVENESS_SECURITY_LEVEL_PARAMETER

120

ERROR_CANT_GET_FACE_IMAGE

121

ERROR_INVALID_IMAGE_POLICY_PARAMETER

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.