Setup Configuration Components¶
This section presents the different customizable parameters of the XpressID.
Loading¶
| Number | Parameter | Default Value |
|---|---|---|
| 1 | logo.media logo.show |
- false |
| 2 | backgroundColor | #000D44 |
| 3 | text textColor |
Loading #FFFFFF |
| 4 | progressIndicator.backgroundColor progressIndicator.color |
#FFFFFF #00051A |
- Example
{
"platform": "ios",
"operationMode": "idv",
"flowSetup": {
"core": {
"confirmProcess": true
},
"stages": [
"document"
],
"options": {
"document": {
"captures": [
{
"documentTypes": [
"ES2_ID"
]
}
]
}
}
},
"setup": {
"loading": {
"text": "loadingText",
"backgroundColor": "#C0C0C0",
"textColor": "#0000FF",
"progressIndicator": {
"backgroundColor": "#000000",
"color": "#FFFF00"
},
"logo": {
"show": true,
"media": "custom_logo"
}
}
}
}
Document¶
Document & Country Selector¶
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | logo.media logo.show |
- false |
|
| 2 | backgroundColor | #FFFFFF | |
| 3 | buttons.close.show | false | |
| 4 | title.text title.textColor |
Choose your document’s country & document type #00051A |
Elige tu país y tipo de documento #00051A |
| 5 | countryChooser.title.text countryChooser.title.textColor |
What country does your document belong to? #00051A |
¿A qué país pertenece tu documento? #00051A |
| 6 | countryChooser.picker.backgroundColor countryChooser.picker.textColor countryChooser.picker.borderColor countryChooser.picker.states.hover.borderColor countryChooser.defaultCountry geolocation |
#FFFFFF #000D44 #000D44 #EE686A ES true |
#FFFFFF #000D44 #000D44 #EE686A ES true |
| 7 | documentChooser.title.text documentChooser.title.textColor |
What kind of ID is it? #00051A |
¿Qué tipo de ID es? #00051A |
| 8 | documentChooser.buttons.iconColor documentChooser.buttons.states.active.iconColor |
#000D44 #FFFFFF |
|
| 9 | documentChooser.buttons.idCard.text documentChooser.buttons.drivingLicense.text documentChooser.buttons.healthCard.text documentChooser.buttons.professionalCard.text documentChooser.buttons.passport.text documentChooser.buttons.others.text documentChooser.buttons.cartaceo.text documentChooser.buttons.fm3.text |
ID card Driver’s license Health card Professional card Passport Other documents Cartaceo ID card FM3 (residence permit) |
Documento de identidad Licencia de conducir Tarjeta sanitaria Cédula profesional Pasaporte Otros documentos Cartaceo de identidad (papel) FM3 (permiso de residencia) |
| 10 | documentChooser.buttons.backgroundColor documentChooser.buttons.textColor documentChooser.buttons.borderColor documentChooser.buttons.states.active.backgroundColor documentChooser.buttons.states.hover.borderColor |
#FFFFFF #00051A #000D44 #000D44 #EE686A |
#FFFFFF #00051A #000D44 #000D44 #EE686A |
- Example
{
"platform": "ios",
"operationMode": "idv",
"flowSetup": {
"core": {
"confirmProcess": true
},
"stages": [
"document"
],
"options": {
"document": {
"captures": [
{
"documentTypes": [
"SelectedByUser"
],
"documentSelector": {
"setup": {
"backgroundColor": "#1ca515",
"logo": {
"show": true,
"media": "custom_logo"
},
"title": {
"text": "documentSelectorTitle",
"textColor": "#FFFFFF"
},
"containerBox": {
"borderColor": "#1ca515",
"show": true
},
"buttons": {
"close": {
"show": true
}
},
"countryChooser": {
"title": {
"text": "countryChooserTitle",
"textColor": "#92f70a"
},
"picker": {
"backgroundColor": "#0a4bf7",
"textColor": "#f70acc",
"borderColor": "#f7400a",
"states": {
"hover": {
"borderColor": "#f0f70a"
}
}
}
},
"documentChooser": {
"title": {
"text": "documentChooserTitle",
"textColor": "#0af7f0"
},
"buttons": {
"backgroundColor": "#000000",
"iconColor": "#0af718",
"textColor": "#748575",
"borderColor": "#FFFFFF",
"states": {
"active": {
"backgroundColor": "#FFFFFF",
"iconColor": "#000D44"
},
"hover": {
"borderColor": "#000000"
}
},
"idCard": {
"text": "idCardText"
},
"drivingLicense": {
"text": "drivingLicenseText"
},
"healthCard": {
"text": "healthCardText"
},
"professionalCard": {
"text": "professionalCardText"
},
"passport": {
"text": "passportText"
},
"others": {
"text": "othersText"
},
"cartaceo": {
"text": "cartaceoText"
},
"fm3": {
"text": "fm3Text"
}
}
},
"geolocation": false
}
}
}
]
}
}
}
}
Document Capture¶
Instructions Modal¶
The instructions modal screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: tutorial_show. By default, this parameter is NO.
If you choose to display it, the configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | tutorial_titleText tutorial_titleTextColor |
Document Capture #000D44 |
Captura Documento |
| 2 | tutorial_backgroundColor tutorial_gifPath tutorial_show |
#FFFFFF - NO |
|
| 3 | tutorial_bodyText tutorial_bodyTextColor |
1. Center your document inside the rectangle 2. Make sure there are no highlights or shadows in your document 3. The document will be captured automatically #000D44 |
1. Centre su documento dentro del rectángulo 2. Asegúrese de que no hay brillos o sombras en su documento 3. El documento se capturará de forma automática |
| 4 | tutorial_continueBackgroundColor tutorial_continueButtonText tutorial_continueButtonTextColor |
#000D44 Start #FFFFFF |
Comenzar |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document" ], "core": { "confirmProcess": true }, "options": { "document": { "captures": [ { "documentTypes": [ "XX" ], "setup": { "tutorial_titleText": "tutorial_titleText", "tutorial_titleTextColor": "#FFF000", "tutorial_backgroundColor": "#DDDDDD", "tutorial_gifPath": "custom.gif", "tutorial_show": "YES", "tutorial_bodyText": "tutorial_bodyText", "tutorial_bodyTextColor": "#00FFF0", "tutorial_continueBackgroundColor": "#999999", "tutorial_continueButtonText": "tutorial_continueButtonText", "tutorial_continueButtonTextColor": "#000FFF" } } ] } } } }
Capture¶
The capture screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | captureInfo_bodyText captureInfo_bodyTextPassport captureInfo_show captureInfo_titleText captureInfo_titleTextPassport positiveButtonText permissionRefused_body permissionRefused_title |
The photos will be taken automatically The photos will be taken automatically YES - - Continue The permission was rejected. You need to activate it manually: Settings > Application > Activate Permission Required permission |
Se tomarán las fotos automáticamente Se tomarán las fotos automáticamente Continuar Ha rechazado el permiso. Tiene que activarlo manualmente en: Ajustes > Aplicación > Activar Permiso Permiso requerido |
| 2 | closeButton_show closeButton_image |
NO ic_closebutton.png |
|
| 3 | capture_backgroundColor | #000D4480 | |
| 4 | documentObverse_notFoundText documentObverse_passportNotFound documentObverse_startDelay documentReverse_notFoundText documentReverse_startDelay info_backgroundColor info_textColor |
Show the front of your document Adjust the Passport page 0 Show the back of your document 0 #000D44 #FFFFFF |
Muestre la parte delantera de su documento Encaje la página del pasaporte Muestre la parte trasera de su documento |
| 5 | secondsBeforeWarning_incompleteProcessText secondsBeforeWarning_showObverseShutterButton secondsBeforeWarning_showReverseShutterButton secondsBeforeWarning_shutterButtonText shutterButton_backgroundColor shutterButton_borderColor shutterButton_messageBackgroundColor shutterButton_messageText shutterButton_messageTextColor shutterButton_show |
40 10 10 6 #EAE9E9 #CCCCCC #000D44 Tap the button to take the photo #FFFFFF YES |
Presione el botón para sacar la foto |
| 6 | tick_circleColor tick_color |
#DCEFD4 #53A335 |
|
| 7 | arrow_color1 arrow_color2 arrow_color3 arrow_color4 arrow_color5 arrow_show |
#85CAFF #CCEFFF #E2F1F9 #EDF4F8 #F9FAFB YES |
|
| 8 | guide_detectionColor1 guide_detectionColor2 guide_detectionColor3 guide_documentCloseColor guide_documentFarColor showRectangle |
#53A335 #87BF72 #BADAAE #EB8D00 #EB8D00 YES |
|
| 9 | guide_documentCloseText guide_documentFarText |
Too close! Place the device further Too far! Place the device closer |
¡Demasiado cerca! Aleje el dispositivo ¡Demasiado lejos! Acerque el dispositivo |
| 10 | stencil | YES |
- Example
{
"platform": "ios",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{
"documentTypes": [
"XX_Passport_YYYY"
],
"setup": {
"captureInfo_bodyText": "captureInfo_bodyText",
"captureInfo_bodyTextPassport": "captureInfo_bodyTextPassport",
"captureInfo_show": "YES",
"captureInfo_titleText": "captureInfo_titleText",
"captureInfo_titleTextPassport": "captureInfo_titleTextPassport",
"positiveButtonText": "positiveButtonText",
"permissionRefused_body": "permissionRefused_body",
"permissionRefused_title": "permissionRefused_title",
"closeButton_show": "YES",
"closeButton_image": "closeButton_image",
"capture_backgroundColor": "#AAAAAA",
"documentObverse_notFoundText": "documentObverse_notFoundText",
"documentObverse_passportNotFound": "documentObverse_passportNotFound",
"documentObverse_startDelay": "1",
"documentReverse_notFoundText": "documentReverse_notFoundText",
"documentReverse_startDelay": "3",
"info_backgroundColor": "#DDDDDD",
"info_textColor": "#F0FF00",
"secondsBeforeWarning_incompleteProcessText": "60",
"secondsBeforeWarning_showObverseShutterButton": "6",
"secondsBeforeWarning_showReverseShutterButton": "6",
"secondsBeforeWarning_shutterButtonText": "10",
"shutterButton_backgroundColor": "#00AA00",
"shutterButton_borderColor": "#BBBBBB",
"shutterButton_messageBackgroundColor": "#CCCCCC",
"shutterButton_messageText": "shutterButton_messageText",
"shutterButton_messageTextColor": "#0000AA",
"shutterButton_show": "YES",
"tick_circleColor": "#A0AA0A",
"tick_color": "#0AA0AA",
"arrow_color1": "#0000FF",
"arrow_color2": "#0000FF",
"arrow_color3": "#0000FF",
"arrow_color4": "#0000FF",
"arrow_color5": "#0000FF",
"arrow_show": "YES",
"guide_detectionColor1": "#FF0000",
"guide_detectionColor2": "#00FF00",
"guide_detectionColor3": "#0000FF",
"guide_documentCloseColor": "#F00FF0",
"guide_documentFarColor": "#00FF0F",
"showRectangle": "YES",
"guide_documentCloseText": "guide_documentCloseText",
"guide_documentFarText": "guide_documentFarText",
"stencil": "YES"
}
}
]
}
}
}
}
Review Image¶
The review image screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: capture_showDocumentCaptured. By default, this parameter is YES.
If you choose to display it, the configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | help_buttonIcon | help.png | |
| 2 | capture_showDocumentCaptured review_backgroundColor |
YES #ACB0C3 |
|
| 3 | review_validateCapturedDocumentText review_validateCapturedDocumentTextColor |
Please make sure the photo is readable and sharp #000D44 |
Por favor, asegúrese de que la foto es legible y nítida |
| 4 | repeatButton_backgroundColor repeatButton_icon repeatButton_text repeatButton_textColor |
#FFFFFF - Repeat #000D44 |
Repetir |
| 5 | review_buttonsWidthDivisor | 2 | |
| 6 | continueButton_backgroundColor continueButton_icon continueButton_text continueButton_textColor |
#000D44 - Continue #FFFFFF |
Continuar |
| 7 | error_validationBackgroundColor error_validationTextColor help_text |
#000D44 #FFFFFF Please, check that your document is focused, without cuts and without any kind of brightness that prevents its perfect reading. |
Por favor, compruebe que su documento está enfocado, sin cortes y sin ningún tipo de brillo que impida su perfecta lectura. |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document" ], "core": { "confirmProcess": true }, "options": { "document": { "captures": [ { "documentTypes": [ "XX" ], "setup": { "help_buttonIcon": "help_buttonIcon", "capture_showDocumentCaptured": "YES", "review_backgroundColor": "#AAAAAA", "review_validateCapturedDocumentText": "review_validateCapturedDocumentText", "review_validateCapturedDocumentTextColor": "#AA0000", "repeatButton_backgroundColor": "#999999", "repeatButton_icon": "repeatButton_icon", "repeatButton_text": "repeatButton_text", "repeatButton_textColor": "#00FFF0", "review_buttonsWidthDivisor": "3", "continueButton_backgroundColor": "#BBBBBB", "continueButton_icon": "continueButton_icon", "continueButton_text": "continueButton_text", "continueButton_textColor": "#00FFFF", "error_validationBackgroundColor": "#CCCCCC", "error_validationTextColor": "#FFFF00", "help_text": "help_text" } } ] } } } }
Selfie¶
Passive Capture¶
Instructions Modal¶
The instructions modal screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: tutorial_show. By default, this parameter is YES.
If you choose to display it, the configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | tutorial_backgroundColor tutorial_header tutorial_headerColor tutorial_show |
#FFFFFF - #1A5EB0 YES |
|
| 2 | tutorial_bodyTextColor tutorial_step1Body tutorial_step1Title tutorial_titleTextColor |
#000D44 Find a place with good lighting and avoid standing in backlight. Find the right place #000D44 |
Busca un lugar con buena iluminación y evita colocarte a contraluz. Busca el lugar adecuado |
| 3 | tutorial_nextButtonText tutorial_nextButtonTextColor |
Next #000D44 |
Siguiente |
| 4 | tutorial_positionPointColor | #000D44 | |
| 5 | tutorial_startButtonGradient1 tutorial_startButtonGradient2 tutorial_startButtonText tutorial_startButtonTextColor |
#000D44 #000D44 Start #FFFFFF |
Comenzar |
| 6 | tutorial_step2Body tutorial_step2Title |
Try to hold the phone as vertical as possible and look at it from the front. Avoid any element that covers your face (hair, mask, etc.) Hold the phone vertically |
Procura que el teléfono esté lo más en vertical posible y míralo de frente. Evita elementos que te cubran la cara (el pelo, la mascarilla, etc.) Sujeta el telefono en vertical |
| 7 | tutorial_previousButtonText tutorial_previousButtonTextColor |
Previous #000D44 |
Anterior |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "selfie" ], "core": { "confirmProcess": true }, "options": { "selfie": { "liveness": "passive", "setup": { "tutorial_backgroundColor": "#CCCCCC", "tutorial_header": "tutorial_header", "tutorial_headerColor": "#000FFF", "tutorial_show": "YES", "tutorial_bodyTextColor": "#00FFF0", "tutorial_step1Body": "tutorial_step1Body", "tutorial_step1Title": "tutorial_step1Title", "tutorial_titleTextColor": "#00AA00", "tutorial_nextButtonText": "tutorial_nextButtonText", "tutorial_nextButtonTextColor": "#00FFF0", "tutorial_positionPointColor": "#0FFF00", "tutorial_startButtonGradient1": "#00FFFF", "tutorial_startButtonGradient2": "#FFFF00", "tutorial_startButtonText": "tutorial_startButtonText", "tutorial_startButtonTextColor": "#AA00AA", "tutorial_step2Body": "tutorial_step2Body", "tutorial_step2Title": "tutorial_step2Title", "tutorial_previousButtonText": "tutorial_previousButtonText", "tutorial_previousButtonTextColor": "#FFF000" } } } } }
Capture¶
The capture screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | centerFaceWarning_body centerFaceWarning_show centerFaceWarning_title permissionRefused_body permissionRefused_title positiveButtonText selectCamera |
Automatic selfie. Center your face in the oval frame NO - The permission was rejected. You need to activate it manually: Settings > Application > Activate Permission Required permission Continue front |
Selfie automático: centre su cara en el óvalo. Ha rechazado el permiso. Tiene que activarlo manualmente en: Ajustes > Aplicación > Activar Permiso Permiso requerido Continuar |
| 2 | closeButton_image closeButton_show |
ic_closebutton.png NO |
|
| 3 | livePhotoSetUp_showOrientationCorrector orientation_backgroundColor orientation_opacity |
YES #000D4480 YES |
|
| 4 | faceDetection_deviceIncorrectPositionText informativeText_backgroundColor informativeText_color faceDetection_bringCloserFaceText faceDetection_centerFaceText faceDetection_info |
Hold the phone vertically in front of you #FFFFFF #000D44 Get closer to the camera Center your face in the oval Now, place your face inside the frame and hold steady while we take a photo |
Pon el teléfono en vertical frente a ti Acérquese a la cámara Centre su cara en el óvalo Ahora, encaja tu cara en el marco y mantente estable mientras tomamos una foto |
| 5 | capture_backgroundColor | #000D4480 | |
| 6 | faceDetection_faceTightness faceDetection_shapeIsOval guide_faceDetectectedButNotCenteredOvalColor guide_faceDetectedOvalColor guide_show mobileOval_color mobileOval_show |
tight YES #EB8D00 #53A335 YES #00CC00 NO |
|
| 7 | countdown_position | center | |
| 8 | tick_circleColor tick_color tick_show |
#DCEFD4 #53A335 YES |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "selfie" ], "core": { "confirmProcess": true }, "options": { "selfie": { "liveness": "passive", "setup": { "centerFaceWarning_body": "centerFaceWarning_body", "centerFaceWarning_show": "YES", "centerFaceWarning_title": "centerFaceWarning_title", "permissionRefused_body": "permissionRefused_body", "permissionRefused_title": "permissionRefused_title", "positiveButtonText": "positiveButtonText", "selectCamera": "front", "closeButton_image": "closeButton_image", "closeButton_show": "YES", "livePhotoSetUp_showOrientationCorrector": "YES", "orientation_backgroundColor": "#999999", "orientation_opacity": "YES", "faceDetection_deviceIncorrectPositionText": "faceDetection_deviceIncorrectPositionText", "informativeText_backgroundColor": "#DDDDDD", "informativeText_color": "#FFFF00", "faceDetection_bringCloserFaceText": "faceDetection_bringCloserFaceText", "faceDetection_centerFaceText": "faceDetection_centerFaceText", "faceDetection_info": "faceDetection_info", "capture_backgroundColor": "#AAAAAA", "faceDetection_faceTightness": "tight", "faceDetection_shapeIsOval": "YES", "guide_faceDetectectedButNotCenteredOvalColor": "#FF0000", "guide_faceDetectedOvalColor": "#00FF00", "guide_show": "YES", "mobileOval_color": "#FFF000", "mobileOval_show": "YES", "countdown_position": "center", "tick_circleColor": "#A0AA0A", "tick_color": "#0AA0AA", "tick_show": "YES" } } } } }
Review Image¶
The review image screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: livePhotoSetUp_showSelfieTaken. By default, this parameter is YES.
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | livePhotoSetUp_showSelfieTaken review_backgroundColor review_text review_textColor |
YES #FFFFFF Make sure your face looks complete and that your expression is natural #000D44 |
Asegúrese de que su cara se ve completa y de que su expresión es natural |
| 2 | repeatButton_backgroundColor repeatButton_icon repeatButton_text repeatButton_textColor |
#FFFFFF - Repeat #000D44 |
Repetir |
| 3 | continueButton_backgroundColor continueButton_icon continueButton_text continueButton_textColor |
#000D44 - Continue #FFFFFF |
Continuar |
| 4 | help_backgroundColor help_text help_textColor |
#000D44 Check that your face is shown complete, with a natural expression and without any shine or shadow. #FFFFFF |
Compruebe que su cara se muestra completa, con una expresión natural y sin ningún tipo de brillo o sombra. |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "selfie" ], "core": { "confirmProcess": true }, "options": { "selfie": { "liveness": "passive", "setup": { "livePhotoSetUp_showSelfieTaken": "YES", "review_backgroundColor": "#BBBBBB", "review_text": "review_text", "review_textColor": "#0000FF", "repeatButton_backgroundColor": "#AAAAAA", "repeatButton_icon": "repeatButton_icon", "repeatButton_text": "repeatButton_text", "repeatButton_textColor": "#00FF00", "continueButton_backgroundColor": "#BBBBBB", "continueButton_icon": "continueButton_icon", "continueButton_text": "continueButton_text", "continueButton_textColor": "#00FFFF", "help_backgroundColor": "#CCCCCC", "help_text": "help_text", "help_textColor": "#0000FF" } } } } }
Active Capture¶
Instructions Modal¶
The instructions modal screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: tutorial_show. By default, this parameter is YES.
If you choose to display it, the configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | tutorial_backgroundColor tutorial_header tutorial_headerColor tutorial_show |
#FFFFFF - #1A5EB0 YES |
|
| 2 | tutorial_bodyTextColor tutorial_step1Body tutorial_step1Title tutorial_titleTextColor |
#000D44 Find a place with good lighting and avoid standing in backlight. Find the right place #000D44 |
Busca un lugar con buena iluminación y evita colocarte a contraluz. Busca el lugar adecuado |
| 3 | tutorial_nextButtonText tutorial_nextButtonTextColor |
Next #000D44 |
Siguiente |
| 4 | tutorial_positionPointColor | #000D44 | |
| 5 | tutorial_startButtonGradient1 tutorial_startButtonGradient2 tutorial_startButtonText tutorial_startButtonTextColor |
#000D44 #000D44 Start #FFFFFF |
Comenzar |
| 6 | tutorial_step2Body tutorial_step2Title |
Try to hold the phone as vertical as possible and look at it from the front. Avoid any element that covers your face (hair, mask, etc.) Hold the phone vertically |
Procura que el teléfono esté lo más en vertical posible y míralo de frente. Evita elementos que te cubran la cara (el pelo, la mascarilla, etc.) Sujeta el telefono en vertical |
| 7 | tutorial_previousButtonText tutorial_previousButtonTextColor |
Previous #000D44 |
Anterior |
| 8 | tutorial_faceMovementProcessBody tutorial_faceMovementProcessTitle |
1. Place your face in the center of the oval and wait for the countdown. 2. Rotate your face in the direction indicated by the arrows. 3. Continue the movements until the process is complete. Follow the instructions |
1. Coloque su cara en el centro del óvalo y espere a la cuenta atrás. 2. Gire su cara en la dirección indicada por las flechas. 3. Haga los movimientos hasta completar el proceso. Sigue las instrucciones |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "selfie" ], "core": { "confirmProcess": true }, "options": { "selfie": { "liveness": "active", "challengeLength": 2, "setup": { "tutorial_backgroundColor": "#CCCCCC", "tutorial_header": "tutorial_header", "tutorial_headerColor": "#000FFF", "tutorial_show": "YES", "tutorial_bodyTextColor": "#00FFF0", "tutorial_step1Body": "tutorial_step1Body", "tutorial_step1Title": "tutorial_step1Title", "tutorial_titleTextColor": "#00AA00", "tutorial_nextButtonText": "tutorial_nextButtonText", "tutorial_nextButtonTextColor": "#00FFF0", "tutorial_positionPointColor": "#0FFF00", "tutorial_startButtonGradient1": "#00FFFF", "tutorial_startButtonGradient2": "#FFFF00", "tutorial_startButtonText": "tutorial_startButtonText", "tutorial_startButtonTextColor": "#AA00AA", "tutorial_step2Body": "tutorial_step2Body", "tutorial_step2Title": "tutorial_step2Title", "tutorial_previousButtonText": "tutorial_previousButtonText", "tutorial_previousButtonTextColor": "#FFF000", "tutorial_faceMovementProcessBody": "tutorial_faceMovementProcessBody", "tutorial_faceMovementProcessTitle": "tutorial_faceMovementProcessTitle" } } } } }
Capture¶
The capture screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | centerFaceWarning_body centerFaceWarning_show centerFaceWarning_title permissionRefused_body permissionRefused_title positiveButtonText selectCamera |
Automatic selfie. Center your face in the oval frame NO - The permission was rejected. You need to activate it manually: Settings > Application > Activate Permission Required permission Continue front |
Selfie automático: centre su cara en el óvalo. Ha rechazado el permiso. Tiene que activarlo manualmente en: Ajustes > Aplicación > Activar Permiso Permiso requerido Continuar |
| 2 | closeButton_image closeButton_show |
ic_closebutton.png NO |
|
| 3 | livePhotoSetUp_showOrientationCorrector orientation_backgroundColor orientation_opacity |
YES #000D4480 YES |
|
| 4 | faceDetection_deviceIncorrectPositionText informativeText_backgroundColor informativeText_color faceDetection_bringCloserFaceText faceDetection_centerFaceText faceDetection_info |
Hold the phone vertically in front of you #FFFFFF #000D44 Get closer to the camera Center your face in the oval Now, place your face inside the frame and hold steady while we take a photo |
Pon el teléfono en vertical frente a ti Acérquese a la cámara Centre su cara en el óvalo Ahora, encaja tu cara en el marco y mantente estable mientras tomamos una foto |
| 5 | capture_backgroundColor | #000D4480 | |
| 6 | faceDetection_faceTightness faceDetection_shapeIsOval guide_faceDetectectedButNotCenteredOvalColor guide_faceDetectedOvalColor guide_show mobileOval_color mobileOval_show |
tight YES #EB8D00 #53A335 YES #00CC00 NO |
|
| 7 | countdown_position | center | |
| 8 | faceMovement_arrowColor faceMovement_bottomText faceMovement_centerText faceMovement_leftText faceMovement_rightText faceMovement_showArrows faceMovement_topText |
#000D44 Turn your face down ¡Great! Look back to the center Turn your face to your left Turn your face to your right Turn your face down YES |
Gira la cara hacia abajo ¡Bien! Vuelve al centro Gira la cara hacia tu izquierda Gira la cara hacia tu derecha Gira la cara hacia arriba |
| 9 | tick_circleColor tick_color tick_show |
#DCEFD4 #53A335 YES |
|
| 10 | processExplanation_body processExplanation_errorTitleColor processExplanation_show processExplanation_step1 processExplanation_step2 processExplanation_step3 processExplanation_text |
Let's start the process again. After taking the photo, follow these instructions to validate. Make sure to be in a well lit environment without elements that cover your face. #000D44 YES 1- Turn your head in the direction indicated 2- You will hear a sound when you do it correctly 3- Vuelve a mirar al centro para continuar Have any doubts? |
Vamos a empezar de nuevo el proceso. Después de sacar la foto, sigue estas instrucciones para hacer la validación. Asegúrate de estar en un entorno con luz y sin elementos que tapen tu cara. 1- Gira la cabeza en la dirección indicada 2- Escucharás un sonido al hacer el giro correctamente 3- Vuelve a mirar al centro para continuar ¿No sabes qué hacer? |
| 11 | processExplanation_buttonText | I GOT IT, CONTINUE | ENTENDIDO, CONTINUAR |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "selfie" ], "core": { "confirmProcess": true }, "options": { "selfie": { "liveness": "active", "challengeLength": 2, "setup": { "centerFaceWarning_body": "centerFaceWarning_body", "centerFaceWarning_show": "YES", "centerFaceWarning_title": "centerFaceWarning_title", "permissionRefused_body": "permissionRefused_body", "permissionRefused_title": "permissionRefused_title", "positiveButtonText": "positiveButtonText", "selectCamera": "front", "closeButton_image": "closeButton_image", "closeButton_show": "YES", "livePhotoSetUp_showOrientationCorrector": "YES", "orientation_backgroundColor": "#999999", "orientation_opacity": "YES", "faceDetection_deviceIncorrectPositionText": "faceDetection_deviceIncorrectPositionText", "informativeText_backgroundColor": "#DDDDDD", "informativeText_color": "#FFFF00", "faceDetection_bringCloserFaceText": "faceDetection_bringCloserFaceText", "faceDetection_centerFaceText": "faceDetection_centerFaceText", "faceDetection_info": "faceDetection_info", "capture_backgroundColor": "#AAAAAA", "faceDetection_faceTightness": "tight", "faceDetection_shapeIsOval": "YES", "guide_faceDetectectedButNotCenteredOvalColor": "#FF0000", "guide_faceDetectedOvalColor": "#00FF00", "guide_show": "YES", "mobileOval_color": "#FFF000", "mobileOval_show": "YES", "countdown_position": "center", "faceMovement_arrowColor": "#00FF00", "faceMovement_bottomText": "faceMovement_bottomText", "faceMovement_centerText": "faceMovement_centerText", "faceMovement_leftText": "faceMovement_leftText", "faceMovement_rightText": "faceMovement_rightText", "faceMovement_showArrows": "YES", "faceMovement_topText": "faceMovement_topText", "tick_circleColor": "#A0AA0A", "tick_color": "#0AA0AA", "tick_show": "YES", "processExplanation_body": "processExplanation_body", "processExplanation_errorTitleColor": "#FF0000", "processExplanation_show": "YES", "processExplanation_step1": "processExplanation_step1", "processExplanation_step2": "processExplanation_step2", "processExplanation_step3": "processExplanation_step3", "processExplanation_text": "processExplanation_text", "processExplanation_buttonText": "processExplanation_buttonText" } } } } }
Review Image¶
The review image screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: livePhotoSetUp_showSelfieTaken. By default, this parameter is YES.
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | livePhotoSetUp_showSelfieTaken review_backgroundColor review_text review_textColor |
YES #FFFFFF Make sure your face looks complete and that your expression is natural #000D44 |
Asegúrese de que su cara se ve completa y de que su expresión es natural |
| 2 | repeatButton_backgroundColor repeatButton_icon repeatButton_text repeatButton_textColor |
#FFFFFF - Repeat #000D44 |
Repetir |
| 3 | continueButton_backgroundColor continueButton_icon continueButton_text continueButton_textColor |
#000D44 - Continue #FFFFFF |
Continuar |
| 4 | help_backgroundColor help_text help_textColor |
#000D44 Check that your face is shown complete, with a natural expression and without any shine or shadow. #FFFFFF |
Compruebe que su cara se muestra completa, con una expresión natural y sin ningún tipo de brillo o sombra. |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "selfie" ], "core": { "confirmProcess": true }, "options": { "selfie": { "liveness": "active", "challengeLength": 2, "setup": { "livePhotoSetUp_showSelfieTaken": "YES", "review_backgroundColor": "#BBBBBB", "review_text": "review_text", "review_textColor": "#0000FF", "repeatButton_backgroundColor": "#AAAAAA", "repeatButton_icon": "repeatButton_icon", "repeatButton_text": "repeatButton_text", "repeatButton_textColor": "#00FF00", "continueButton_backgroundColor": "#BBBBBB", "continueButton_icon": "continueButton_icon", "continueButton_text": "continueButton_text", "continueButton_textColor": "#00FFFF", "help_backgroundColor": "#CCCCCC", "help_text": "help_text", "help_textColor": "#0000FF" } } } } }
Video¶
Instructions Modal¶
The instructions modal screen is configurable to be displayed or not. If you do not desired to show this screen, the applicable configuration parameter would be: tutorial_show. By default, this parameter is NO.
If you choose to display it, the configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | tutorial_titleText tutorial_titleTextColor |
Video Capture #000D44 |
Captura Video |
| 2 | tutorial_backgroundColor tutorial_gifPath tutorial_show |
#FFFFFF - NO |
|
| 3 | tutorial_bodyText tutorial_bodyTextColor tutorial_bodyTextPassport |
When required: • Say your NAME and SURNAME. • Show the FRONT SIDE of your document. • Show the BACK SIDE of your document. #000D44 When required: • Say your NAME and SURNAME. • Show the PAGE WITH THE DATA of the passport. |
Cuando se le solicite: • Diga su NOMBRE y APELLIDOS. • Muestre la parte DELANTERA de su documento. • Muestre la parte TRASERA de su documento. Cuando se le solicite: • Diga su NOMBRE y APELLIDOS. • Muestre la PÁGINA CON LOS DATOS del pasaporte. |
| 4 | tutorial_continueButtonBackgroundColor tutorial_continueButtonText tutorial_continueButtonTextColor |
#000D44 Start #FFFFFF |
Comenzar |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "video" ], "core": { "confirmProcess": true }, "options": { "video": { "setup": { "tutorial_titleText": "tutorial_titleText", "tutorial_titleTextColor": "#FFA000", "tutorial_backgroundColor": "#BBBBBB", "tutorial_gifPath": "custom.gif", "tutorial_show": "YES", "tutorial_bodyText": "tutorial_bodyText", "tutorial_bodyTextColor": "#00FF0F", "tutorial_bodyTextPassport": "tutorial_bodyTextPassport", "tutorial_continueButtonBackgroundColor": "#00FFFF", "tutorial_continueButtonText": "tutorial_continueButtonText", "tutorial_continueButtonTextColor": "#0000FF" } } } } }
Capture¶
The capture screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | permissionRefused_title processExplanation_authenticationTitle processExplanation_onboardingPassportTitle processExplanation_onboardingTitle processExplanation_show |
Required permission Liveness test Video Capture Video Capture NO |
Permiso requerido Prueba de vida Captura Video Captura Video |
| 2 | permissionRefused_body processExplanation_authenticationText processExplanation_onboardingPassportText processExplanation_onboardingText |
The permission was rejected. You need to activate it manually: Settings > Application > Activate Permission The application needs to record a video selfie as proof of life. When required: • Say your NAME and SURNAME. • Show the PAGE WITH THE DATA of the passport. When required: • Say your NAME and SURNAME. • Show the FRONT SIDE of your document. • Show the BACK SIDE of your document. |
Ha rechazado el permiso. Tiene que activarlo manualmente en: Ajustes > Aplicación > Activar permiso La aplicación necesita grabar un vídeo selfie como prueba de vida. Cuando se le solicite: • Diga su NOMBRE y APELLIDOS. • Muestre la PÁGINA CON LOS DATOS del pasaporte. Cuando se le solicite: • Diga su NOMBRE y APELLIDOS. • Muestre la parte DELANTERA de su documento. • Muestre la parte TRASERA de su documento. |
| 3 | permissionRefused_buttonText positiveButtonText |
Open settings Continue |
Abrir ajustes Continuar |
| 4 | closeButton_image closeButton_show |
ic_closebutton NO |
|
| 5 | capture_backgroundAlpha documentCapturedLabel_icon documentCapturedLabel_position documentCapturedLabel_text livenessTest_type onlyObverse reverseDetection videoRecording_onlyObverseTimeoutSeconds videoRecording_timeoutSeconds videoRecording_includeDateInMetadata videoRecording_includeTokenInMetadata videoRecording_token |
0.85 bottom Captured onboarding NO YES 17 41 YES YES |
Capturado |
| 6 | informativeLabel_backgroundColor informativeLabel_borderColor informativeLabel_position informativeLabel_step1Text informativeLabel_step2Text informativeLabel_step2PassportText informativeLabel_step3Text informativeLabel_textColor informativeLabel_show label_flashingColor |
#000D4480 #000D4480 top Say your NAME and SURNAME. Show the FRONT SIDE of the document. Show the page that contains the data of the passport. And now the BACK SIDE. #FFFFFF YES #3995EC |
Diga su NOMBRE y APELLIDOS. Muestre la parte DELANTERA del documento. Muestre la página con los datos del pasaporte. Y ahora muestre la parte TRASERA. |
| 7 | faceDetection_keepTimeoutSeconds faceDetection_shapeIsOval faceMobileOval_color faceMobileOval_show guideOval_show |
7 YES #3995EC YES YES |
|
| 8 | documentObverse_notFoundErrorTitle documentReverse_notFoundErrorTitle faceDetection_notFoundErrorTitle videoRecording_errorTitle |
Error Error Error Error |
Error Error Error Error |
| 9 | documentObverse_notFoundErrorText documentReverse_notFoundErrorText faceDetection_notFoundErrorText videoRecording_errorText |
You have to show the FRONT SIDE of your identity document by putting it close to the camera. You have to show the BACK SIDE of your identity document by putting it close to the camera. You stopped looking at the camera and the process has come to a halt. Please, start again You have not shown the document or it was too far away and the process has come to a halt. Please, start again. |
Debe mostrar la parte DELANTERA del documento acercándolo a cámara. Debe mostrar a parte TRASERA del documento acercándolo a cámara. Ha dejado de mirar a la cámara y el proceso se ha detenido. Por favor, empiece de nuevo. No ha mostrado el documento o el documento estaba muy lejos y el proceso se ha detenido. Por favor, empiece de nuevo. |
| 10 | countdown_textColor documentMobileRectangle_color documentMobileRectangle_show documentObverse_keepTimeoutSeconds documentObverse_notFoundTimeoutSeconds documentReverse_keepTimeoutSeconds documentReverse_notFoundTimeoutSeconds guideRectangle_position guideRectangle_show |
#FFFFFF #3995EC YES 6 6 6 12 top YES |
|
| 11 | documentLabel_backgroundColor documentLabel_obverseText documentLabel_reverseText documentLabel_textColor |
#000D4480 FRONT SIDE BACK SIDE #FFFFFF |
PARTE DELANTERA PARTE TRASERA |
| 12 | tick_circleColor tick_color |
#DCEFD4 #53A335 |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document", "video" ], "core": { "confirmProcess": true }, "options": { "video": { "setup": { "permissionRefused_title": "permissionRefused_title", "processExplanation_authenticationTitle": "processExplanation_authenticationTitle", "processExplanation_onboardingPassportTitle": "processExplanation_onboardingPassportTitle", "processExplanation_onboardingTitle": "processExplanation_onboardingTitle", "processExplanation_show": "YES", "permissionRefused_body": "permissionRefused_body", "processExplanation_authenticationText": "processExplanation_authenticationText", "processExplanation_onboardingPassportText": "processExplanation_onboardingPassportText", "processExplanation_onboardingText": "processExplanation_onboardingText", "permissionRefused_buttonText": "permissionRefused_buttonText", "positiveButtonText": "positiveButtonText", "closeButton_image": "ic_sdk_0", "closeButton_show": "YES", "capture_backgroundAlpha": "1", "documentCapturedLabel_icon": "ic_sdk_1", "documentCapturedLabel_position": "top", "documentCapturedLabel_text": "documentCapturedLabel_text", "livenessTest_type": "onboarding", "onlyObverse": "NO", "reverseDetection": "YES", "videoRecording_onlyObverseTimeoutSeconds": "30", "videoRecording_timeoutSeconds": "60", "videoRecording_includeDateInMetadata": "NO", "videoRecording_includeTokenInMetadata": "YES", "videoRecording_token": "videoRecording_token", "informativeLabel_backgroundColor": "#FF0000", "informativeLabel_borderColor": "#00FF0F", "informativeLabel_position": "center", "informativeLabel_step1Text": "informativeLabel_step1Text", "informativeLabel_step2Text": "informativeLabel_step2Text", "informativeLabel_step2PassportText": "informativeLabel_step2PassportText", "informativeLabel_step3Text": "informativeLabel_step3Text", "informativeLabel_textColor": "#CCCCCC", "informativeLabel_show": "YES", "label_flashingColor": "#F00FF0", "faceDetection_keepTimeoutSeconds": "5", "faceDetection_shapeIsOval": "YES", "faceMobileOval_color": "#AA00AA", "faceMobileOval_show": "YES", "guideOval_show": "YES", "documentObverse_notFoundErrorTitle": "documentObverse_notFoundErrorTitle", "documentReverse_notFoundErrorTitle": "documentReverse_notFoundErrorTitle", "faceDetection_notFoundErrorTitle": "faceDetection_notFoundErrorTitle", "videoRecording_errorTitle": "videoRecording_errorTitle", "documentObverse_notFoundErrorText": "documentObverse_notFoundErrorText", "documentReverse_notFoundErrorText": "documentReverse_notFoundErrorText", "faceDetection_notFoundErrorText": "faceDetection_notFoundErrorText", "videoRecording_errorText": "videoRecording_errorText", "countdown_textColor": "#FFA000", "documentMobileRectangle_color": "#A0AA0A", "documentMobileRectangle_show": "YES", "documentObverse_keepTimeoutSeconds": "3", "documentObverse_notFoundTimeoutSeconds": "5", "documentReverse_keepTimeoutSeconds": "3", "documentReverse_notFoundTimeoutSeconds": "10", "guideRectangle_position": "bottom", "guideRectangle_show": "YES", "documentLabel_backgroundColor": "#0AA0AA", "documentLabel_obverseText": "documentLabel_obverseText", "documentLabel_reverseText": "documentLabel_reverseText", "documentLabel_textColor": "#FFFF00", "tick_circleColor": "#0000FF", "tick_color": "#DDDDDD" } } } } }
NFC¶
Instructions Modal¶
The instruction modal screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | closeButton_image closeButton_show |
ic_closebutton NO |
|
| 2 | tutorial_backgroundColor | #ACB0C3 | |
| 3 | tutorial_titleText tutorial_titleTextColor tutorial_bodyText tutorial_bodyTextColor |
#FFFFFF NFC Reading: • Place your ID card against the top of your device. • Hold it still until you are notified that the NFC has been read successfully. #000D44 |
Lectura NFC: • Coloque su tarjeta de identificación contra la parte superior de su dispositivo. • Manténgalo quieto hasta que se le notifique que la NFC se ha leído correctamente. |
| 4 | tutorial_continueButtonBackgroundColor tutorial_continueButtonText tutorial_continueButtonTextColor |
#000D44 Start #FFFFFF |
Comenzar |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document" ], "core": { "confirmProcess": true }, "options": { "document": { "captures": [ { "documentTypes": [ "XX" ], "nfc": { "enabled": true, "setup": { "closeButton_image": "ic_sdk_0", "closeButton_show": "YES", "tutorial_backgroundColor": "#0AA0AA", "tutorial_titleText": "tutorial_titleText", "tutorial_titleTextColor": "#FFA000", "tutorial_bodyText": "tutorial_bodyText", "tutorial_bodyTextColor": "#FF0000", "tutorial_continueButtonBackgroundColor": "#00AA00", "tutorial_continueButtonText": "tutorial_continueButtonText", "tutorial_continueButtonTextColor": "#999999" } } } ] } } } }
Reading¶
The NFC reading screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | nfcReading_authenticatingText nfcReading_hintText nfcReading_readingText |
Authenticating with document... Put your document close to the top tip of your iPhone. Do not move the document. The device is scanning the chip of the document. |
Autenticando con su documento... Acerque el documento a la parte superior de su iPhone. No mueva el documento. El dispositivo está escaneando el chip de su documento. |
| 2 | nfcReading_successText | The document has been successfully scanned | Se ha escanedo el documento correctamente |
| 3 | nfcReading_keysErrorText nfcReading_severalTagsErrorText nfcReading_unexpectedErrorText nfcReading_userCancelledText |
Fill in the next information so the iPhone can scan the chip of the document More than 1 tag was found. Please present only 1 tag. It's been impossible to scan the chip of your document. Follow the instructions and repeat the process User cancelled NFC reading |
Complete la siguiente información para que el iPhone pueda escanear el chip de su documento Se ha encontrado más de una etiqueta NFC. Por favor, asegúrese de tener sólo una al alcance No se ha podido escanear el chip de su documento. Siga las instrucciones y repita el proceso El usuario ha cancelado la lectura NFC |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document" ], "core": { "confirmProcess": true }, "options": { "document": { "captures": [ { "documentTypes": [ "XX" ], "nfc": { "enabled": true, "setup": { "nfcReading_authenticatingText": "nfcReading_authenticatingText", "nfcReading_hintText": "nfcReading_hintText", "nfcReading_readingText": "nfcReading_readingText", "nfcReading_successText": "nfcReading_successText", "nfcReading_keysErrorText": "nfcReading_keysErrorText", "nfcReading_severalTagsErrorText": "nfcReading_severalTagsErrorText", "nfcReading_unexpectedErrorText": "nfcReading_unexpectedErrorText", "nfcReading_userCancelledText": "nfcReading_userCancelledText", } } } ] } } } }
Form¶
The form screen configuration options are listed below:
| Number | Parameter | Default Value | |
|---|---|---|---|
| 1 | form_titleText form_titleTextColor |
Fill in the following data #000D44 |
Rellene los siguientes campos |
| 2 | form_backgroundColor form_textColor |
#FFFFFF #000D44 |
|
| 3 | form_documentNumberText | Document number | Número de documento |
| 4 | form_dateOfBirthDayText form_dateOfBirthMonthText form_dateOfBirthText form_dateOfBirthYearText |
Day Month Date of birth Year |
Día Mes Fecha de nacimiento Año |
| 5 | form_dateOfExpiryDayText form_dateOfExpiryMonthText form_dateOfExpiryText form_dateOfExpiryYearText |
Day Month Date of expiry Year |
Día Mes Fecha de validez Año |
| 6 | form_continueButtonBackgroundColor form_continueButtonText form_continueButtonTextColor |
#000D44 Continue #FFFFFF |
Continuar |
- Example
{ "platform": "ios", "operationMode": "idv", "flowSetup": { "stages": [ "document" ], "core": { "confirmProcess": true }, "options": { "document": { "captures": [ { "documentTypes": [ "XX" ], "nfc": { "enabled": true, "setup": { "form_titleText": "form_titleText", "form_titleTextColor": "#00FF00", "form_backgroundColor": "#AAAAAA", "form_textColor": "#F00FF0", "form_documentNumberText": "form_documentNumberText", "form_dateOfBirthDayText": "form_dateOfBirthDayText", "form_dateOfBirthMonthText": "form_dateOfBirthMonthText", "form_dateOfBirthText": "form_dateOfBirthText", "form_dateOfBirthYearText": "form_dateOfBirthYearText", "form_dateOfExpiryDayText": "form_dateOfExpiryDayText", "form_dateOfExpiryMonthText": "form_dateOfExpiryMonthText", "form_dateOfExpiryText": "form_dateOfExpiryText", "form_dateOfExpiryYearText": "form_dateOfExpiryYearText", "form_continueButtonBackgroundColor": "#0000FF", "form_continueButtonText": "form_continueButtonText", "form_continueButtonTextColor": "#FFFF00" } } } ] } } } }