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" }