Sensory Truly Secure
Sensory’s embedded facial verification AI, TrulySecure, attempts to validate a person based on the matching of a facial image with a locally stored, and encrypted enrolled image – by either accepting or rejecting the identity claim (one-to-one matching). This model is most commonly used to grant access to a device as seen in mobile phones, tablets, and PCs.
This integration allows your app to use several biometric functions, such as face recognition technology and voice biometry. Since such qualifiers are unique to individuals, face and voice biometrics solutions offer greater security than traditional security measures such as profiles, passwords or pass-phrases, PIN numbers, and personal information.
Advantages of this integration include:
Authenticate users via face, voice, or a fusion of face and voice.
Face liveness detection to protect against spoof attacks.
FIDO UAF certified for Android.
Automatic learning of voices over time, which allows apps to become personalized.
Note
The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.
Technical Details
API ID | 551 |
API Code | SENSORY_TS |
Call API version | 1.0 |
SDK Version | iOS: [4.4.0] Android: [3.8.2] |
App Version | 5.9 |
Objective | Biometrics validations (voice, fingerprints, face) |
Classification | Biometrics |
Available for | iOS, Android (Voice not available for iOS) |
Warning
On iOS since version 6.5.0.11, the Sensory Truly Secure CallAPI has dependency on Firebase Vision. The plist file generated from a Firebase console is required to be added to the application.
Use the Sensory Truly Secure Integration in Studio
The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.
Gets information about which vaultIds are supported by this API, as well as which of them are currently enrolled. | |
Enrolls a user in the indicated mode. | |
Disenrolls a user in the indicated mode. | |
Defines UI parameters. |
Get Status
This function gets information about which vaultIds are supported by this API, as well as which of them are currently enrolled.
Parameter Configuration
This function requires you to configure the enrollment mode (face or voice) in register 390, as described in the Input Registers table.
Function ID
Register | Value |
|---|---|
110 | 1 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
390 | Enrollment mode (the options are FACE and VOICE for Android and only FACE for iOS) | Yes | Enrollment Mode: FACE, FACE_TEMPLATE, VOICE |
Output Registers
Register | Description | Value | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||
290 | Status | 0: Mode Not Supported 1: No user enrolled 2: Enrolled | ||||||||||||||||||
291 | API Version | Call API version | ||||||||||||||||||
292 | SDK Version | Sensory TS SDK version | ||||||||||||||||||
293 | Expiration Date | Expiration date (Epoch format) |
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.
Disenroll
This function disenrolls a previously enrolled person for the selected mode: face or voice.
Parameter Configuration
This function requires you to configure the value of register 390 with the enrollment mode (see Input Registers below).
Function ID
Register | Value |
|---|---|
110 | 4 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
390 | Enrollment mode. Voice is only available for Android. | Yes | FACE, VOICE |
Output Registers
Register | Description | Value | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||||
290 | Enrollment ID | ID for this enrollment. |
Set UI Params
This function allows you to define texts and images to customize the UI for enrollment and authentication.
Parameter Configuration
This function requires you to send metadata in JSON format in the value of Register 390 (Input parameters). Once the parameters have been defined, they will remain active during the execution of the application. With each successful invocation of this function, all the parameters sent in the JSON are updated. All parameters not defined in the JSON will keep their default values.
Note
To revert to the default parameters, invoke the function leaving the value of register 390 empty.
To learn which parameters can be configured using this function, contact your admin.
Function ID
Register | Value |
|---|---|
110 | 5 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
390 | UI Parameters | Yes | List of parameters in JSON format. See example below. {
'img_biometrics_face_action':'alert_v',
'img_biometrics_voice_action':'tux',
'txt_voice_enroll_instruction':'Please, repeat a phrase.'
} |
Output Registers
Register | Description | Value | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
|