Skip to main content

Veritran Docs

ScanCard

This function initializes the scan of the identity document.

It requires you to configure the input register values shown in the Input Registers section.

Note

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.

Function ID

Register

Value

110

1

Input Registers
Input Registers

Register

Description

Mandatory

Default

Value

Library Version

390

INPUT_COUNTRY_CODE

No

1

Description

Value

Type

ARGENTINA

1

INT

GUATEMALA

3

INT

MEXICO

VOTER ID

4

INT

COLOMBIA

(binary version 6.5.3 or higher)

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

Hexadecimal color that the Capture button will take when enabled.

2

395

INPUT_BUTTON_DISABLED_COLOR

No

#B3B3B3

Hexadecimal color that the Capture button will take when disabled.

2

396

INPUT_JSON_MESSAGES_STRING

No

-

STRING

3 (only available for binary version 6.5.3 or higher)

397

INPUT_TIME_OUT_SECONDS

No

See note below.

INT

4 (only available for binary version 6.5.3 or higher)

Note

By default, if a value for this field is not provided, the timeout will not start running. This parameter corresponds to a waiting time in seconds that includes the waiting time for each side of the document. It is restarted once the first face has been scanned. The timeout starts running when the user presses the scan button.

To get output images in base64, send an 800000 token for input register images:

  • INPUT_FACEIMAGEID

  • INPUT_FRONTIMAGEID

  • INPUT_BACKIMAGEID

INPUT_JSON_MESSAGES_STRING

Warning

Only available for binary version 6.5 or later.

Strings in JSON format that indicate the texts to be displayed in the messages, buttons and labels while scanning the front and back of a document. The JSON should be as follows:

{
"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.]"
}

Refer to the example below to learn more about how to complete each value. If no JSON is provided, the default values will be used.

{
"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 was successfully scanned"
}
Output Registers
Output Registers
Argentina

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

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

YYYYMMDD

295

OUTPUT_BIRTHDATE

YYYYMMDD

296

OUTPUT_PDF417

<PDF417 STRING>

Note

Output image should be called using the Photo Call API's functions Get Picture and Take Picture.

Guatemala

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

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

YYYYMMDD

296

OUTPUT_ISSUEDATE

YYYYMMDD

297

OUTPUT_PDF417

<PDF417 STRING>

The OUTPUT_NATIONALITY has the characteristic of returning the full name of the country or the three-letter country code (e.g. GTM for Guatemala, ARG for Argentina, COL for Colombia), depending on the document version.

Mexico

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

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 YYYYMMDD

297

ELECTOR KEY

STRING (from 6.5.3 UI branches onwards)

298

CURP

STRING

299

REGISTER YEAR

STRING (from 6.5.3 UI branches onwards)

Colombia

Warning

Only available for binary version 6.5.3 or higher.

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

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 DDMMYYYY

294

ISSUEDATE

STRING DDMMYYYY

295

PLACEOFBIRTH

STRING

296

ISSUING AUTHORITY

STRING

297

SEX

STRING

Chile

Warning

Only available for binary version 6.5.3 or higher.

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

TYPE

STRING (ALIEN_ID or 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/yyyy

296

OUTPUT_DOCUMENT_NUMBER || OUTPUT_SERIE_NUMBER (For the ALIEN_ID, the OUTPUT_DOCUMENT_NUMBER is returned and, for the ID, the OUTPUT_SERIE_NUMBER is returned)

STRING

297

OUTPUT_DATE_OF_ISSUE

STRING dd/mm/yyyy

298

OUTPUT_DATE_OF_EXPIRY

STRING dd/mm/yyyy

299

OUTPUT_RUN

STRING

Bolivia

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

DATA_MATCH_RESULT

STRING

Possible values:

  • success: Both sides of the document belong to the same person.

  • failed: The sides of the document do not belong to the same person.

  • notPerformed: The SDK does not support the match due to the document type.

291

DOCUMENT_TYPE_AND_NUMBER

STRING - Concatenated document type and number DOCUMENT_TYPE|DOCUMENT_NUMBER

292

ISSUING_DATE and EXPIRY_DATE

STRING - Concatenated issuing and expiry date, separated by a hyphen (-)

dd/mm/yyyy-dd/mm/yyyy

293

ISSUING_AUTHORITY

STRING

294

ADDRESS

STRING

295

BIRTH_DATE

STRING dd/mm/yyyy

296

FULL_NAME

STRING

297

MARITAL_STATUS

STRING

298

BIRTH_PLACE

STRING

299

PROFESSION

STRING

Nicaragua

Register

Description

Value

112

Call Result

-1

GENERIC_ERROR

000

NO_ERROR

2

INVALID_IMAGE_EXTENSION_FACTOR

102

PARAMS_ERROR

103

Mandatory fields not found: Mandatory document fields not found on the scanned document

130

UNKNOWN_COUNTRY_CODE

131

LICENSE_EXPIRED_ERROR

132

TIME_OUT_ERROR

133

UNSUPPORTED_VERSION_ERROR

200

CANCEL_ERROR

290

DATA_MATCH_RESULT

STRING

Possible values:

  • success: Both sides of the document belong to the same person.

  • failed: The sides of the document do not belong to the same person.

  • notPerformed: The SDK does not support the match due to the document type.

291

BIRTH_DATE

STRING dd/mm/yyyy

292

ISSUING_DATE and EXPIRY_DATE

STRING - Concatenated issuing and expiry date, separated by a hyphen (-)

dd/mm/yyyy-dd/mm/yyyy

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

Note

Output image should be called using the Photo Call API's functions Get Picture and Take Picture.

In this section: