Skip to main content

Veritran Docs

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

000

API_NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_INCODE_NOT_INITIALIZED

004

SESSION_ERROR

005

GEOLOCATION_ERROR

006

SCAN_ID_ERROR

007

SCAN_SELFIE_ERROR

008

VIDEO_SELFIE_ERROR

009

CLAVE_DE_ELECTOR_ERROR

010

CANCELLED_BY_USER

011

ANDROID_VERSION_ERROR

012

FACE_MATCH_ERROR

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
}
}