Skip to main content

Veritran Docs

Enroll-3D

This function allows your app to enroll a person according to the capture of their determined biometric data. You can send an externalDatabaseRefID parameter as a unique identifier (for example, the identification number of the person) to be associated with a faceScan. Sending this identifier is optional, if it is not sent it will be auto-generated. A session ID is also returned, useful for tracking the scan.

Note

It's required to initialize the SDK (Initialize function) to be able to use the rest of the FaceTec functions.

Parameter Configuration

This function allows you to configure input values as described in the Input Registers table.

Function ID

Register

Value

110

2

Input Registers

Register

Description

Mandatory

Value

Application Version

390

externalDatabaseRefID: Unique Identifier, associate enrollment with an ID. If empty, it generates a random number.

No

[Unique identifier]

7.1.0

396

Output Image ID. Register ID where the user image will be saved.If not set, image won't be saved.

No

[Image ID]

6.5.1

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

106

ERR_STATUS_PERMISSION_NOT_ALLOWED

109

ERROR_SESSION_TOKEN

112

ERROR_EXIT_REASON_ABORTED

115

ERROR_EXIT_REASON_GENERIC_ERROR

120

ERROR_CANT_GET_FACE_IMAGE

213

ERROR_DUPLICATED_EXTERNAL_DATABASE_REFID

307

ERROR_SDK_STATUS_LICENSE_EXPIRED_OR_INVALID

308

ERROR_SDK_STATUS_ENCRYPTION_KEY_INVALID

311

ERROR_SDK_NOT_INITIALIZED

290

SessionID

ID for this enrollment

291

ImageBase64

AuditTrailImage in base64

292

externalDatabaseRefID

externalDatabaseRefID used in the session