Incode
The Incode integration allows digital onboarding in Mexico with the use of facial biometrics, video recording, and validation with the INE. If you want to adapt this integration to another country, contact your admin.
Advantages of this integration include:
Scanning Mexican IDs and taking front and back images, capturing all the information.
Performing facial recognition and comparing the face detected with the ID.
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 | 591 |
API Code | Custom (Incode) |
Call API version | 1 |
SDK Version | iOS: [3.0.0-d-vc] - Last update: Oct 2021 Android: [3.0.0] - Last update: Oct 2021 |
App Version | lib_incode |
Objective | Biometric validation |
Classification | Biometrics |
Available for | iOS, Android (requires GPS, camera, microphone and external storage permissions on Android) |
Important
All processes in this integration require Geolocation.
Use the Incode 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.
Allows you to create a session to perform the onboarding process. | |
Allows you to perform the onboarding process, using the actions set as input parameters. | |
Allows you to end an onboarding session. |
CreateSession
This function allows you to create a session to perform the onboarding process.
Parameter Configuration
This function requires you to complete the input parameters with the validation modules and custom files.
Function ID
Register | Value |
|---|---|
110 | 1 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
390 | Validation Modules | X | ID;FACE_RECOGNITION;LIVENESS;GOVERNMENT_VALIDATION;GOVERNMENT_ORC_VALIDATION;GOVERNMENT_FACE_VALIDATION;VIDEO_SELFIE |
391 | CustomFiles | X | KEY1:VALUE1;KEY2:VALUE2 |
Output Registers
Register | Description | Value | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||||||||||
290 | Token | STRING | ||||||||||||||||||||||||||
291 | InterviewID | STRING | ||||||||||||||||||||||||||
292 | Region | STRING |
BuildOnboarding
This function allows you to perform the onboarding process, using the actions set as input parameters.
Parameter Configuration
This function requires you to complete the input parameters with the session ID and the actions to be performed.
Function ID
Register | Value |
|---|---|
110 | 2 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
300 | Session ID, generated by the CreateSession function. | X | InterviewId |
301 | Actions to be performed, separated by semicolons. | X | GEOLOCATION;SCAN_ID;FACE_SELFIE;FACE_MATCH;VIDEO_SELFIE |
302 | Images are compressed by default. This register is used to indicate that images should not be compressed. | UNCOMPRESSED |
Output Registers
Register | Description | Value | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||||||||||||||||||||||
291 | JSON with the results of the actions requested. | {
"geolocation": {
"addressFields": {
"colony":"",
"street":"",
"city":"",
"state":"",
"postalCode":""
}
},
"idScan": {
"frontIdCroppedFace":"{Image in Base64 format}",
"frontIdResult":0,
"backIdResult":0,
"idCaptureResult": {
"frontIdImage":"{Image in Base64 format}",
"backIdImage":"{Image in Base64 format}"
},
"ocrData": {
"curp":"",
"registrationDate":0,
"numeroEmisionCredencial":"",
"addressFields": {
"colony":"",
"street":"",
"city":"",
"state":"",
"postalCode":""
},
"birthDate":"172627200000",
"claveDeElector":"",
"issueDate":0,
"cic":"",
"expirationDate":0,
"address":"",
"ocr":"",
"gender":"",
"name": {
"firstName":"",
"paternalLastName":"",
"fullName":"",
"maternalLastName":""
}
}
},
"selfieScan": {
"image":"{Image in Base64 format}"
},
"faceMatch": {
"isFaceMatched":true
},
"videoSelfie":{
"success":true
}
} |
EndSession
This function allows you to end an onboarding session.
Parameter Configuration
This function doesn't require the configuration of any parameters.
Function ID
Register | Value |
|---|---|
110 | 1 |
Output Registers
Register | Description | Value | ||||
|---|---|---|---|---|---|---|
112 | Call Result |
|