ScanCard
Esta función inicializa el escaneo del documento de identidad.
[en] It requires you to configure the input register values shown in the Input Registers section.
Nota
[en] The integration also allows you to use images and other animation files previously added to the app binary. Contact the Mobile Product team for more information on the use of images or animations.
ID de la función
Registro | Valor |
|---|---|
110 | 1 |
Registros de entrada
Registro | Descripción | Obligatorio | Opción por defecto | Valor | Versión de la biblioteca | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
390 | INPUT_COUNTRY_CODE | [en] No | 1 |
| 1 | ||||||||||||||||||||||||
391 | INPUT_FACEIMAGEID | [en] No | - | STRING | 1 | ||||||||||||||||||||||||
392 | INPUT_FRONTIMAGEID | [en] No | - | STRING | 1 | ||||||||||||||||||||||||
393 | INPUT_BACKIMAGEID | [en] No | - | STRING | 1 | ||||||||||||||||||||||||
394 | INPUT_BUTTON_ENABLED_COLOR | [en] No | #2E97F2 | Color hexadecimal que adoptará el botón Capture cuando se habilite. | 2 | ||||||||||||||||||||||||
395 | INPUT_BUTTON_DISABLED_COLOR | [en] No | #B3B3B3 | Color hexadecimal que adoptará el botón Capture cuando se deshabilite. | 2 | ||||||||||||||||||||||||
396 | [en] No | - | STRING | 3 (solo disponible para la versión del binario 6.5.3 o posterior) | |||||||||||||||||||||||||
397 | INPUT_TIME_OUT_SECONDS | [en] No | Consulta la nota a continuación. | INT | 4 (solo disponible para la versión del binario 6.5.3 o posterior) |
Nota
De forma predeterminada, si no se proporciona un valor para este campo, el tiempo de espera no comenzará a ejecutarse. Este parámetro corresponde a un tiempo de espera en segundos que incluye el tiempo de espera para cada cara del documento y que se reinicia una vez escaneada la primera cara. El tiempo de espera comienza a correr cuando el usuario presiona el botón de exploración
Para obtener las imágenes de salida en base64, envía un token 800000 para las imágenes del registro de entrada:
INPUT_FACEIMAGEID
INPUT_FRONTIMAGEID
INPUT_BACKIMAGEID
INPUT_JSON_MESSAGES_STRING
Aviso
Solo disponible para la versión del binario 6.5 o posterior.
Strings en formato JSON que indican los textos que se mostrarán en los mensajes, los botones y las etiquetas mientras escaneas el anverso y el reverso de un documento. El JSON debería ser así: El JSON debe ser el siguiente:
{
"card_message_front": "[text to be displayed on the instructions while scanning the front of the document.]",
"card_message_back": "[text to be displayed on the instructions while scanning the back of the document.]",
"dot_label_front": "[text of the label that refers to the front of the document.]",
"dot_label_back": "[text of the label that refers to the back of the document.]",
"main_button_clicked_text": "[text to be displayed on the scanning button when the document is being scanned.]",
"main_button_title_front": "[text to be displayed on the scanning button when ready to scan the front of the document.]",
"main_button_title_back": "[text to be displayed on the scanning button when ready to scan the back of the document.]",
"main_button_title_success": "[text to be displayed on the scanning button when the scan is complete.]",
"card_message_success": "[text to be displayed on the final message when the scan is complete.]"
}Consulte el siguiente ejemplo para obtener más información sobre cómo completar cada valor. Si no se proporciona JSON, se utilizarán los valores predeterminados.
{
"card_message_front": "Position the front of the document within the frame",
"card_message_back": "Position the back of the document within the frame",
"dot_label_front": "Front",
"dot_label_back": "Back",
"main_button_clicked_text": "Scanning...",
"main_button_title_front": "Capture Front",
"main_button_title_back": "Capture Back",
"main_button_title_success": "Finished",
"card_message_success": "The document has been successfully scanned"
}Registros de salida
Argentina
Registro | Descripción | Valor | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||||||
290 | OUTPUT_DOCUMENTNUMBER | STRING | ||||||||||||||||||||
291 | OUTPUT_NAME | STRING | ||||||||||||||||||||
292 | OUTPUT_SURNAME | STRING | ||||||||||||||||||||
293 | OUTPUT_SEX | M/F | ||||||||||||||||||||
294 | OUTPUT_EXPIRYDATE | YYYYMMDD | ||||||||||||||||||||
295 | OUTPUT_BIRTHDATE | YYYYMMDD | ||||||||||||||||||||
296 | OUTPUT_PDF417 | <PDF417 STRING> |
Nota
Se debe llamar a la imagen de salida usando las funciones Get Picture y Take Picture de call API Photo.
Guatemala
Registro | Descripción | Valor | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||||||
290 | OUTPUT_DOCUMENTNUMBER | STRING | ||||||||||||||||||||
291 | OUTPUT_NAME | STRING | ||||||||||||||||||||
292 | OUTPUT_SURNAME | STRING | ||||||||||||||||||||
293 | OUTPUT_SEX | M/F | ||||||||||||||||||||
294 | OUTPUT_NATIONALITY | STRING | ||||||||||||||||||||
295 | OUTPUT_BIRTHDATE | YYYYMMDD | ||||||||||||||||||||
296 | OUTPUT_BIRTHDATE | YYYYMMDD | ||||||||||||||||||||
297 | OUTPUT_PDF417 | <PDF417 STRING> |
OUTPUT_NATIONALITY tiene la característica de devolver el nombre completo del país o el código de país de tres letras (por ejemplo, GTM para Guatemala, ARG para Argentina, COL para Colombia) en función de la versión del documento.
México
Registro | Descripción | Valor | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||||||
290 | OCR | STRING | ||||||||||||||||||||
291 | CIC | STRING | ||||||||||||||||||||
292 | NAME | STRING | ||||||||||||||||||||
293 | PATERNAL_SURNAME | STRING | ||||||||||||||||||||
294 | MATERNAL_SURNAME | STRING | ||||||||||||||||||||
295 | EMISSION_NUMBER | STRING | ||||||||||||||||||||
296 | VALIDITY | STRING YYYYMMDD | ||||||||||||||||||||
297 | ELECTOR KEY | STRING (desde las ramas UI 6.5.3 en adelante) | ||||||||||||||||||||
298 | CURP | STRING | ||||||||||||||||||||
299 | REGISTER YEAR | STRING (desde las ramas UI 6.5.3 en adelante) |
Colombia
Aviso
Solo disponible para la versión del binario 6.5.3 o posterior.
Registro | Descripción | Valor | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||||||
290 | DOCUMENT_NUMBER | STRING | ||||||||||||||||||||
291 | NAME | STRING FIRSTNAME|SECONDNAME | ||||||||||||||||||||
292 | SURNAME | STRING PATERNALSURNAME|MATERNALSURNAME | ||||||||||||||||||||
293 | BIRTHDATE | STRING DDMMYYYY | ||||||||||||||||||||
294 | ISSUEDATE | STRING DDMMYYYY | ||||||||||||||||||||
295 | PLACEOFBIRTH | STRING | ||||||||||||||||||||
296 | ISSUING AUTHORITY | STRING | ||||||||||||||||||||
297 | SEX | STRING |
Chile
Aviso
Solo disponible para la versión del binario 6.5.3 o posterior.
Registro | Descripción | Valor | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||||||||||||||||
290 | TYPE | STRING (ALIEN_ID o ID) | ||||||||||||||||||||
291 | OUTPUT_NAME | STRING | ||||||||||||||||||||
292 | OUTPUT_LASTNAME | STRING | ||||||||||||||||||||
293 | OUTPUT_NACIONALITY | STRING | ||||||||||||||||||||
294 | OUTPUT_SEX | STRING | ||||||||||||||||||||
295 | OUTPUT_DATE_OF_BIRTH | STRING dd/mm/aaaa | ||||||||||||||||||||
296 | OUTPUT_DOCUMENT_NUMBER || OUTPUT_SERIE_NUMBER (para ALIEN_ID, se devuelve el OUTPUT_DOCUMENT_NUMBER y, para el ID, se devuelve OUTPUT_SERIE_NUMBER) | STRING | ||||||||||||||||||||
297 | OUTPUT_DATE_OF_ISSUE | STRING dd/mm/aaaa | ||||||||||||||||||||
298 | OUTPUT_DATE_OF_EXPIRY | STRING dd/mm/aaaa | ||||||||||||||||||||
299 | OUTPUT_RUN | STRING |
[en] Bolivia
[en] Register | [en] Description | [en] Value | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | [en] Call Result |
| ||||||||||||||||||||
290 | [en] DATA_MATCH_RESULT | [en] STRING [en] Possible values:
| ||||||||||||||||||||
291 | [en] DOCUMENT_TYPE_AND_NUMBER | [en] STRING - Concatenated document type and number DOCUMENT_TYPE|DOCUMENT_NUMBER | ||||||||||||||||||||
292 | [en] ISSUING_DATE and EXPIRY_DATE | [en] STRING - Concatenated issuing and expiry date, separated by a hyphen (-) [en] dd/mm/yyyy-dd/mm/yyyy | ||||||||||||||||||||
293 | [en] ISSUING_AUTHORITY | [en] STRING | ||||||||||||||||||||
294 | [en] ADDRESS | [en] STRING | ||||||||||||||||||||
295 | [en] BIRTH_DATE | [en] STRING dd/mm/yyyy | ||||||||||||||||||||
296 | [en] FULL_NAME | [en] STRING | ||||||||||||||||||||
297 | [en] MARITAL_STATUS | [en] STRING | ||||||||||||||||||||
298 | [en] BIRTH_PLACE | [en] STRING | ||||||||||||||||||||
299 | [en] PROFESSION | [en] STRING |
[en] Nicaragua
[en] Register | [en] Description | [en] Value | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | [en] Call Result |
| ||||||||||||||||||||
290 | [en] DATA_MATCH_RESULT | [en] STRING [en] Possible values:
| ||||||||||||||||||||
291 | [en] BIRTH_DATE | [en] STRING dd/mm/yyyy | ||||||||||||||||||||
292 | [en] ISSUING_DATE and EXPIRY_DATE | [en] STRING - Concatenated issuing and expiry date, separated by a hyphen (-) [en] dd/mm/yyyy-dd/mm/yyyy | ||||||||||||||||||||
293 | [en] DOCUMENT_NUMBER | [en] STRING | ||||||||||||||||||||
294 | [en] FIRST_NAME | [en] STRING | ||||||||||||||||||||
295 | [en] LAST_NAME | [en] STRING | ||||||||||||||||||||
296 | [en] BIRTH_PLACE | [en] STRING | ||||||||||||||||||||
297 | [en] SEX | [en] STRING | ||||||||||||||||||||
298 | [en] ADDRESS | [en] STRING | ||||||||||||||||||||
299 | [en] BARCODE TEXT | [en] STRING |
Nota
[en] Output image should be called using the Photo Call API's functions Get Picture and Take Picture.