Skip to main content

Veritran Docs

ScanCard

Esta función inicializa el escaneo del documento de identidad.

Requiere configurar los valores de los registros de entrada que se muestran en la sección Registros de entrada.

Nota

La integración también permite usar imágenes y otros archivos de animaciones previamente agregados al binario de la app. Contacta al equipo de Mobile Producto para obtener más información sobre el uso de imágenes o animaciones.

ID de la función

Registro

Value

110

1

Registros de entrada
Registros de entrada

Registro

Descripción

Obligatorio

Opción por defecto

Valor

Versión de la biblioteca

390

INPUT_COUNTRY_CODE

No

1

Description

Valor

Tipo

ARGENTINA

1

INT

GUATEMALA

3

INT

MÉXICO

VOTER ID

4

INT

COLOMBIA

(versión del binario 6.5.3 o posterior)

2

INT

CHILE

5

INT

BOLIVIA

6

INT

NICARAGUA

7

INT

1

391

INPUT_FACEIMAGEID

No

-

STRING

1

392

INPUT_FRONTIMAGEID

No

-

STRING

1

393

INPUT_BACKIMAGEID

No

-

STRING

1

394

INPUT_BUTTON_ENABLED_COLOR

No

#2E97F2

Color en formato hexadecimal que adoptará el botón Capture cuando se habilite.

2

395

INPUT_BUTTON_DISABLED_COLOR

No

#B3B3B3

Color en formato hexadecimal que adoptará el botón Capture cuando se deshabilite.

2

396

INPUT_JSON_MESSAGES_STRING

No

-

STRING

3 (solo disponible para la versiones de binario 6.5.3 o posteriores)

397

INPUT_TIME_OUT_SECONDS

No

Consulta la nota a continuación.

INT

4 (solo disponible para las versiones de binario 6.5.3 o posteriores)

Nota

Por defecto, si no se proporciona un valor para este campo, el tiempo de espera no comenzará a correr. Este parámetro corresponde a un tiempo de espera en segundos que incluye el tiempo de espera para cada lado 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 escaneo.

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 las versiones de binario 6.5 o posteriores.

Strings en formato JSON que indican los textos que se mostrarán en los mensajes, los botones y las etiquetas mientras escaneas el frente y el dorso de un documento. El JSON debe tener el siguiente formato:

{
"card_message_front": "[texto que se mostrará como instrucción al escanear el frente del documento.]",
"card_message_back": "[texto que se mostrará como instrucción al escanear el dorso del documento.]",
"dot_label_front": "[texto de la etiqueta que refiere al frente del documento.]",
"dot_label_back": "[texto de la etiqueta que refiere al dorso del documento.]",
"main_button_clicked_text": "[texto que se mostrará en el botón de escaneo durante el proceso de escaneo.]",
"main_button_title_front": "[texto que se mostrará en el botón de escaneo cuando está listo para escanear el frente del documento.]",
"main_button_title_back": "[texto que se mostrará en el botón de escaneo cuando está listo para escanear el dorso del documento.]",
"main_button_title_success": "[texto que se mostrará en el botón de escaneo cuando finalice el proceso de escaneo.]",
"card_message_success": "[texto que se mostrará como mensaje final cuando finalice el proceso de escaneo.]"
}

Consulta el ejemplo de abajo para obtener más información sobre cómo completar cada valor. Si no se proporciona un JSON, se utilizarán los valores predeterminados.

{
"card_message_front": "Posiciona el frente del documento dentro del recuadro",
"card_message_back": "Posiciona el dorso del documento dentro del recuadro",
"dot_label_front": "Frente",
"dot_label_back": "Dorso",
"main_button_clicked_text": "Escaneando...",
"main_button_title_front": "Capturar frente",
"main_button_title_back": "Capturar dorso",
"main_button_title_success": "Finalizado",
"card_message_success": "El documento se escaneó exitosamente"
}
Registros de salida
Registros de salida
Argentina

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

OUTPUT_DOCUMENTNUMBER

STRING

291

OUTPUT_NAME

STRING

292

OUTPUT_SURNAME

STRING

293

OUTPUT_SEX

M/F

294

OUTPUT_EXPIRYDATE

AAAAMMDD

295

OUTPUT_BIRTHDATE

AAAAMMDD

296

OUTPUT_PDF417

<PDF417 STRING>

Nota

Se debe llamar a la imagen de salida usando las funciones Get Picture y Take Picture de la Call API Photo.

Guatemala

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

OUTPUT_DOCUMENTNUMBER

STRING

291

OUTPUT_NAME

STRING

292

OUTPUT_SURNAME

STRING

293

OUTPUT_SEX

M/F

294

OUTPUT_NATIONALITY

STRING

295

OUTPUT_BIRTHDATE

AAAAMMDD

296

OUTPUT_BIRTHDATE

AAAAMMDD

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) según la versión del documento.

México

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

OCR

STRING

291

CIC

STRING

292

NAME

STRING

293

PATERNAL_SURNAME

STRING

294

MATERNAL_SURNAME

STRING

295

EMISSION_NUMBER

STRING

296

VALIDITY

STRING AAAAMMDD

297

ELECTOR KEY

STRING (desde las ramas de UI 6.5.3 en adelante)

298

CURP

STRING

299

REGISTER YEAR

STRING (desde las ramas de UI 6.5.3 en adelante)

Colombia

Aviso

Solo disponible para versiones de binario 6.5.3 o posteriores.

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

DOCUMENT_NUMBER

STRING

291

NAME

STRING FIRSTNAME|SECONDNAME

292

SURNAME

STRING PATERNALSURNAME|MATERNALSURNAME

293

BIRTHDATE

STRING DDMMAAAA

294

ISSUEDATE

STRING DDMMAAAA

295

PLACEOFBIRTH

STRING

296

ISSUING AUTHORITY

STRING

297

SEX

STRING

Chile

Aviso

Solo disponible para versiones de binario 6.5.3 o posteriores.

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

TYPE

STRING (ALIEN_ID o ID)

291

OUTPUT_NAME

STRING

292

OUTPUT_LASTNAME

STRING

293

OUTPUT_NATIONALITY

STRING

294

OUTPUT_SEX

STRING

295

OUTPUT_DATE_OF_BIRTH

STRING dd/mm/aaaa

296

OUTPUT_DOCUMENT_NUMBER || OUTPUT_SERIE_NUMBER (para ALIEN_ID, devuelve el OUTPUT_DOCUMENT_NUMBER y, para el ID, 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

Bolivia

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

DATA_MATCH_RESULT

STRING

Posibles valores:

  • success: Ambos lados del documento pertenecen a la misma persona.

  • failed: Los lados del documento no pertenecen a la misma persona.

  • notPerformed: El SDK no admite la coincidencia debido al tipo de documento.

291

DOCUMENT_TYPE_AND_NUMBER

STRING - Tipo y número de documento concatenados DOCUMENT_TYPE|DOCUMENT_NUMBER

292

ISSUING_DATE y EXPIRY_DATE

STRING - Fecha de emisión y de vencimiento concatenadas, separadas por un guión (-)

dd/mm/aaaa-dd/mm/aaaa

293

ISSUING_AUTHORITY

STRING

294

ADDRESS

STRING

295

BIRTH_DATE

STRING dd/mm/aaaa

296

FULL_NAME

STRING

297

MARITAL_STATUS

STRING

298

BIRTH_PLACE

STRING

299

PROFESSION

STRING

Nicaragua

Registro

Descripción

Valor

112

Resultado de la Call

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: No se encontraron campos obligatorios en el documento escaneado.

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

DATA_MATCH_RESULT

STRING

Posibles valores:

  • success: Ambos lados del documento pertenecen a la misma persona.

  • failed: Los lados del documento no pertenecen a la misma persona.

  • notPerformed: El SDK no admite la coincidencia debido al tipo de documento.

291

BIRTH_DATE

STRING dd/mm/aaaa

292

ISSUING_DATE y EXPIRY_DATE

STRING - Fecha de emisión y de vencimiento concatenadas, separadas por un guión (-)

dd/mm/aaaa-dd/mm/aaaa

293

DOCUMENT_NUMBER

STRING

294

FIRST_NAME

STRING

295

LAST_NAME

STRING

296

BIRTH_PLACE

STRING

297

SEX

STRING

298

ADDRESS

STRING

299

BARCODE TEXT

STRING

Nota

Se debe llamar a la imagen de salida usando las funciones Get Picture y Take Picture de la Call API Photo.

: