Authenticate-3D
This function authenticates a user against a previous enrollment. The externalDatabaseRefID is used as a unique identifier (the citizenship ID for example) to search for a previous enrollment with which to compare.
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. The externalDatabaseRefID input value is required; without it, the function will have no one to compare the user with and will return an error.
Function ID
Register | Value |
|---|---|
110 | 2 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
390 | externalDatabaseRefID: Unique Identifier, compare current user FaceMap with the FaceMap stored with the externalDatabaseRefID identifier. The function will fail if no value is configured. | Yes | [Unique identifier] |
394 | Output Image ID. Register ID where the user image will be saved. If not set, the image won't be saved. | No | [Image ID] |
Output Registers
Register | Description | Value | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||||||||||||||||||||
290 | SessionID | ID for this enrollment | ||||||||||||||||||||||||||||||||||||
291 | ImageBase64 | AuditTrailImage in base64 | ||||||||||||||||||||||||||||||||||||
292 | externalDatabaseRefID | externalDatabaseRefID used in the session |