Skip to main content

Veritran Docs

Input Registers

Register

Description

Mandatory

Default

Value

Library Version

390

INPUT_COUNTRY_CODE

-

1

Description

Value

Type

ARGENTINA

1

INT

GUATEMALA

3

INT

MEXICO

VOTER ID

4

INT

COLOMBIA

(binary version 6.5.3 or later)

2

INT

CHILE

5

INT

1

391

INPUT_FACEIMAGEID

-

-

STRING

1

392

INPUT_FRONTIMAGEID

-

-

STRING

1

393

INPUT_BACKIMAGEID

-

-

STRING

1

394

INPUT_BUTTON_ENABLED_COLOR

-

#2E97F2

Hexadecimal color that the Capture button will take when enabled.

2

395

INPUT_BUTTON_DISABLED_COLOR

-

#B3B3B3

Hexadecimal color that the Capture button will take when disabled.

2

396

INPUT_JSON_MESSAGES_STRING

-

-

STRING

3 (only available for binary version 6.5.3 or later)

397

INPUT_TIME_OUT_SECONDS

-

See note below.

INT

4 (only available for binary version 6.5.3 or later)

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 and that 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 has been successfully scanned"
}