{ "title": "SDK's Configuration", "description": "Config needed by the Veridas's SDKs.", "type": "object", "$id": "https://docs.veridas.com/", "$defs": { "vdTypes": { "type": ["string", "array"], "enum": ["translatable", "fetchable"] } }, "properties": { "$schema": { "type": "string", "default": "./assets/schema.json", "description": "Setting this parameter to the path of the schema attached with the SDK allows autocompletion while working on the configuration for the SDK." }, "generic": { "description": "Properties used among all SDKs. The properties defined here will be overridden if the same property is defined in the specific SDK (sdkSelfie, sdkDocument, etc).", "type": "object", "properties": { "theme": { "description": "Basic styles for the SDK. If you want advanced personalization, head to Veridas's documentation portal for more information.", "type": "object", "properties": { "colorAlertError": { "description": "Theme color for error alert. Example: oval's color when face is not detected.", "type": "string", "default": "#d63737", "$id": "colorAlertError" }, "colorAlertSuccess": { "description": "Theme color for success alert. Examples: oval's color when process has finished successfully, success tick color.", "type": "string", "default": "#AEE4C1", "$id": "colorAlertSuccess" }, "colorAlertSuccessDark": { "description": "Theme dark color for success alert. Examples: oval's color when process has finished successfully, success tick color.", "type": "string", "default": "#53A335", "$id": "colorAlertSuccessDark" }, "colorAlertDetection": { "description": "Theme dark color for detection alert. Examples: oval's color when detection is success.", "type": "string", "default": "#257CD0", "$id": "colorAlertDetection" }, "colorAlertWarning": { "description": "Theme color for warning alert.", "type": "string", "default": "#EB8D00", "$id": "colorAlertWarning" }, "colorNeutral00": { "description": "Grayscale value. Examples: cards background, messages backgrounds, etc.", "type": "string", "default": "#ffffff", "$id": "colorNeutral00" }, "colorNeutral05": { "description": "Grayscale value. Example: success tick border color.", "type": "string", "default": "#f2f2f2", "$id": "colorNeutral05" }, "colorNeutral20": { "description": "Grayscale value.", "type": "string", "default": "#cccccc", "$id": "colorNeutral20" }, "colorNeutral40": { "description": "Grayscale value. Example: tutorial subtitle text color.", "type": "string", "default": "#999999", "$id": "colorNeutral40" }, "colorNeutral80": { "description": "Grayscale value. Example: tutorial subtitle text color.", "type": "string", "default": "#333333", "$id": "colorNeutral80" }, "colorPrimaryDark": { "description": "Theme primary dark color. Examples: gradient buttons color.", "type": "string", "default": "#000D44", "$id": "colorPrimaryDark" }, "colorPrimaryMain": { "description": "Theme primary color. Examples: text colors, svg colors, etc.", "type": "string", "default": "#000D44", "$id": "colorPrimaryMain" }, "colorPrimaryLight": { "description": "Theme primary light color. Examples: gradient buttons color, sdk background color.", "type": "string", "default": "#3995ec", "$id": "colorPrimaryLight" }, "colorTertiary": { "description": "", "type": "string", "default": "#ff7777", "$id": "colorTertiary" }, "radiusSm": { "description": "Small border radius size. Examples: buttons and cards border radius.", "type": "string", "default": "8px", "$id": "radiusSm" }, "radiusLg": { "description": "Small border radius size. Examples: buttons and cards border radius.", "type": "string", "default": "16px", "$id": "radiusLg" }, "shadowSm": { "description": "Small size box shadow. Examples: cards and buttons box shadows.", "type": "string", "default": "none", "$id": "shadowSm" }, "typographyBodyNormalFontFamily": { "description": "Font family for normal body text. `IMPORTANT: if font family is not supported natively by the browser, you must load it. Check Typography load at setUp section`", "type": "string", "default": "PublicSansNormal", "$id": "typographyBodyNormalFontFamily" }, "typographyBodyRegularFontFamily": { "description": "Font family for regular body text. `IMPORTANT: if font family is not supported natively by the browser, you must load it. Check Typography load at setUp section`", "type": "string", "default": "PublicSansRegular", "$id": "typographyBodyRegularFontFamily" } }, "additionalProperties": false }, "common": { "description": "Common", "type": "object", "properties": { "ui": { "description": "User Interface configuration.", "type": "object", "properties": { "logo": { "type": "object", "properties": { "show": { "description": "If true, displays the logo component, uses a custom image in the assets folder.", "type": "boolean", "default": true, "$id": "logoShow" }, "media": { "description": "Logo media used in multiple views.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/veridasLogo.png", "default": "/images/veridasLogo.png", "$id": "logoMedia" } }, "additionalProperties": false }, "buttons": { "type": "object", "properties": { "close": { "type": "object", "properties": { "show": { "description": "If true, displays a button that shuts down the SDK.", "type": "boolean", "default": false, "$id": "closeButtonShow" }, "media": { "description": "Close button media used in multiple views.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/closeButton.svg", "default": "/images/closeButton.svg", "$id": "closeButtonMedia" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "behavior": { "description": "Customize the behavior of the SDKs.", "type": "object", "properties": { "web": { "type": "object", "properties": { "language": { "description": "SDK text default values language. There are 3 options: `ES`: All default text will be in Spanish, `EN`: All default text will be in English, `browser`: All default text will be in Spanish if the browser language is in Spanish otherwise it will be in English.", "enum": ["ES", "browser"], "type": "string", "default": "browser", "$id": "language" }, "logEvents": { "description": "If true all the events dispatched will be logged in the console following the specified format in the documentation.", "type": "boolean", "default": true, "$id": "logEvents" } }, "additionalProperties": false }, "native": { "type": "object", "properties": {} } }, "additionalProperties": false } }, "additionalProperties": false }, "views": { "type": "object", "properties": { "loading": { "type": "object", "properties": { "media": { "description": "Path for the Spinner. `IMPORTANT: if empty it will use default spinner.`", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "loadingSpinnerMedia" }, "card": { "type": "object", "properties": { "title": { "description": "Text displayed when loading process is running.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Cargando", "EN": "Loading" }, "$id": "loadingTitle" }, "buttons": { "type": "object", "properties": { "restart": { "type": "object", "properties": { "text": { "description": "Text for the button in the loading view that is shown when the SDK is not successfully loaded.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Reiniciar", "EN": "Restart" }, "$id": "loadingRestartButton" } }, "additionalProperties": false } }, "additionalProperties": false }, "media": { "description": "Icon for loading card message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/spinner.gif", "default": "/images/spinner.gif", "$id": "loadingMedia" }, "header": { "description": "Header for text displayed when the loading process is running.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Cargando...", "EN": "Loading..." }, "$id": "loadingHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "sdkSelfie": { "type": "object", "description": "Selfie's configuration properties.", "properties": { "flowType": { "description": "Indicates the flow to use, Selfie, Smile or Selfie Alive Pro.", "type": "string", "enum": ["selfie", "smile", "head"], "default": "head", "$id": "flowType" }, "views": { "type": "object", "properties": { "instructions": { "type": "object", "properties": { "active": { "description": "If true displays an instructions component to inform the user.", "type": "boolean", "default": true, "$id": "selfieInstructionsActive" }, "header": { "type": "object", "properties": { "title": { "description": "Title of the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Antes de comenzar el proceso, lea estas sencillas instrucciones", "EN": "Before starting the process, read these simple instructions" }, "$id": "selfieInstructionsMainHeader" } }, "additionalProperties": false }, "card": { "type": "object", "properties": { "title": { "type": "object", "properties": { "selfie": { "description": "List of titles in selfie flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": ["Posiciónese frente a la cámara"], "EN": ["Position yourself in front of the camera"] }, "$id": "selfieInstructionsSelfieTitle" }, "smile": { "description": "List of titles in smile flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Posiciónese frente a la cámara", "Sonría a cámara" ], "EN": [ "Position yourself in front of the camera", "Smile to the camera" ] }, "$id": "selfieInstructionsSmileTitle" }, "head": { "description": "List of titles in head flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Posiciónese frente a la cámara", "Siga las instrucciones" ], "EN": [ "Position yourself in front of the camera", "Follow the instructions" ] }, "$id": "selfieInstructionsHeadTitle" } }, "additionalProperties": false }, "subtitle": { "type": "object", "properties": { "selfie": { "description": "List of subtitles in selfie flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Asegúrese de no llevar gafas de sol, gorras u otros elementos que tapen su cara" ], "EN": [ "Make sure you are not wearing sunglasses, hats, or other items that cover your face" ] }, "$id": "selfieInstructionsSelfieSubTitle" }, "smile": { "description": "List of subtitles in smile flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Asegúrese de no llevar gafas de sol, gorras u otros elementos que tapen su cara", "Le pedimos que sonría como prueba de vida. La captura se realizará de forma automática" ], "EN": [ "Make sure you are not wearing sunglasses, hats, or other items that cover your face", "We ask you to smile as proof of life. The capture will be done automatically" ] }, "$id": "selfieInstructionsSmileSubTitle" }, "head": { "description": "List of subtitles in head flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Asegúrese de no llevar gafas de sol, gorras u otros elementos que tapen su cara", "1. Encaje la cara en el marco y espere a la detección \n 2. Mueva la cabeza ligeramente en la dirección que le indiquen las flechas \n 3. Cuando la pantalla le indique que lo ha hecho correctamente, vuelva a mirar al centro \n 4. Repita el proceso 2 veces" ], "EN": [ "Make sure you are not wearing sunglasses, hats, or other items that cover your face", "1. Fit the face in the frame and wait for the detection \n 2. Move your head slightly in the direction indicated by the arrows \n 3. When the screen indicates that you have done it correctly, look at the center again \n 4. Repeat the process 2 times" ] }, "$id": "selfieInstructionsHeadSubTitle" } }, "additionalProperties": false }, "media": { "type": "object", "properties": { "selfie": { "description": "List of media in selfie flow for the instructions slides.", "vdTypes": "fetchable", "type": "array", "legacyPathMedia": [ "/images/alive01.png", "/images/alive02.png" ], "default": [ "/images/alive01.png", "/images/alive02.png" ], "$id": "selfieInstructionsSelfieMedia" }, "smile": { "description": "List of media in smile flow for the instructions slides.", "vdTypes": "fetchable", "type": "array", "legacyPathMedia": [ "/images/alive01.png", "/images/alive02.png", "/images/alive03.png" ], "default": [ "/images/alive01.png", "/images/alive02.png", "/images/alive03.png" ], "$id": "selfieInstructionsSmileMedia" }, "head": { "description": "List of media in head flow for the instructions slides.", "vdTypes": "fetchable", "type": "array", "legacyPathMedia": [ "/images/alive01.png", "/images/alive02.png", "/images/alive03.png" ], "default": [ "/images/alive01.png", "/images/alive02.png", "/images/alive03.png" ], "$id": "selfieInstructionsHeadMedia" } }, "additionalProperties": false }, "header": { "description": "Header to display an instructions message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Instrucciones", "EN": "Instructions" }, "$id": "selfieInstructionsHeader" }, "buttons": { "type": "object", "properties": { "next": { "type": "object", "properties": { "media": { "description": "Media for next button in the instructions component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrow-right.svg", "default": "/images/arrow-right.svg", "$id": "selfieInstructionsNextButtonMedia" }, "text": { "description": "Text for next button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Siguiente", "EN": "Next" }, "$id": "selfieInstructionsNextButtonText" } }, "additionalProperties": false }, "previous": { "type": "object", "properties": { "media": { "description": "Media for previous button in the instructions component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrow-left.svg", "default": "/images/arrow-left.svg", "$id": "selfieInstructionsPrevButtonMedia" }, "text": { "description": "Text for previous button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Anterior", "EN": "Previous" }, "$id": "selfieInstructionsPrevButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "progressIndicator": { "type": "object", "properties": { "show": { "description": "If true, displays the progress indicator component.", "type": "boolean", "default": true, "$id": "selfieInstructionsProgressIndicator" } }, "additionalProperties": false }, "buttons": { "type": "object", "properties": { "startProcess": { "type": "object", "properties": { "text": { "description": "Text for continue button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "EN": "Start", "ES": "Comenzar" }, "$id": "selfieInstructionsButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "capture": { "type": "object", "properties": { "guidance": { "type": "object", "properties": { "centered": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the user's face is centered.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Manténgase estable y no sonría", "EN": "Stay still and do not smile" }, "$id": "faceCenteredTitle" }, "media": { "description": "Media image in the face-centered description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "faceCenteredMedia" }, "header": { "description": "Header to display selfie Flow.", "type": "string", "vdTypes": "translatable", "default": { "ES": "Siga las instrucciones", "EN": "Follow the instructions" }, "$id": "faceCenteredHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "notCentered": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the user's face is not centered.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Vuelva a centrar su cara en el óvalo", "EN": "Recenter your face within the oval" }, "$id": "faceNotCenteredTitle" }, "media": { "description": "Media for the error component that shows when the user's face is not centered.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "faceNotCenteredMedia" }, "header": { "description": "Header to display a text message error when face is not centered.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "faceNotCenteredHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "selfie": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the capture component shown in the selfie flow.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Centre su cara en el óvalo", "EN": "Fit your face into the oval" }, "$id": "captureSelfieTitle" }, "media": { "description": "Media image in the selfie capture description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "captureSelfieMedia" }, "header": { "description": "Header to display selfie Flow.", "type": "string", "vdTypes": "translatable", "default": { "ES": "Siga las instrucciones", "EN": "Follow the instructions" }, "$id": "captureSelfieHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "smile": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display smile flow.", "type": "string", "vdTypes": "translatable", "default": { "ES": "Siga las instrucciones", "EN": "Follow the instructions" }, "$id": "captureSmileHeader" }, "title": { "type": "object", "properties": { "smile": { "description": "Title for the capture component shown in the smile flow.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Sonría", "EN": "Smile" }, "$id": "captureSmileTitleSmile" }, "serious": { "description": "Subtitle for the capture component shown in the smile flow.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No sonría", "EN": "Do not smile" }, "$id": "captureSmileTitleSerious" }, "finish": { "description": "Subtitle for the capture component shown in the smile flow.", "vdTypes": "translatable", "type": "string", "default": { "ES": "¡Bien!", "EN": "Great!" }, "$id": "captureSmileTitleFinish" } }, "additionalProperties": false }, "media": { "type": "object", "properties": { "smile": { "description": "Smile media for the capture component shown in the smile flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/faceSmile.svg", "default": "/images/faceSmile.svg", "$id": "captureSmileMediaSmile" }, "serious": { "description": "Serious media for the capture component shown in the smile flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/faceSerious.svg", "default": "/images/faceSerious.svg", "$id": "captureSmileMediaSerious" }, "arrow": { "description": "Arrow media for the capture component shown in the smile flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrowSmile.svg", "default": "/images/arrowSmile.svg", "$id": "captureSmileMediaArrow" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "head": { "type": "object", "properties": { "token": { "description": "Valid token provided by the Validas service, to indicate the head movement challenge that the user must perform. Its recommended to use VDSelfie.initializeSdk(config, aliveChallenge) and in cases where the end user has failed doing the head movement challenge, retrieve a new token from the Backend and pass it to the VDSelfie.restartChallenge(aliveChallenge) method.", "type": "string", "default": "", "$id": "captureHeadToken" }, "card": { "type": "object", "properties": { "header": { "description": "Header for the capture component shown in the head flow when a head movement is required.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Foto de validación", "EN": "Photo Validation" }, "$id": "captureHeadHeader" }, "title": { "type": "object", "properties": { "movement": { "description": "Title for the capture component shown in the head flow when a head movement is required.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Mueva la cabeza", "EN": "Move your head" }, "$id": "captureHeadMovementTitle" }, "back": { "description": "Title for the capture component shown in the head flow when the head is required to move back to the center.", "vdTypes": "translatable", "type": "string", "default": { "ES": "¡Bien! Vuelva a mirar al centro", "EN": "Great! Look back to the center" }, "$id": "captureHeadBackTitle" }, "finish": { "description": "Title for the capture component shown in the head flow when the movement fase is finished.", "vdTypes": "translatable", "type": "string", "default": { "ES": "¡Bien!", "EN": "Great!" }, "$id": "captureHeadFinishTitle" } }, "additionalProperties": false }, "media": { "type": "object", "properties": { "headBottomBack": { "description": "Bottom back head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_bottom_back.gif", "default": "/images/head_bottom_back.gif", "$id": "headBottomBackMedia" }, "headBottom": { "description": "Bottom head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_bottom.gif", "default": "/images/head_bottom.gif", "$id": "headBottomMedia" }, "headCenter": { "description": "Center head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_center.gif", "default": "/images/head_center.gif", "$id": "headCenterMedia" }, "headLeftBack": { "description": "Left back head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_left_back.gif", "default": "/images/head_left_back.gif", "$id": "headLeftBackMedia" }, "headLeft": { "description": "Left head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_left.gif", "default": "/images/head_left.gif", "$id": "headLeftMedia" }, "headRightBack": { "description": "Right back head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_right_back.gif", "default": "/images/head_right_back.gif", "$id": "headRightBackMedia" }, "headRight": { "description": "Right head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_right.gif", "default": "/images/head_right.gif", "$id": "headRightMedia" }, "headTopBack": { "description": "Top back head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_top_back.gif", "default": "/images/head_top_back.gif", "$id": "headTopBackMedia" }, "headTop": { "description": "Top head movement media for the capture component shown in the head flow.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/head_top.gif", "default": "/images/head_top.gif", "$id": "headTopMedia" }, "back": { "description": "Media helper for back message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "backMedia" }, "movement": { "description": "Media helper for movement message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "movementMedia" }, "finish": { "description": "Media helper for finish message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "finishMedia" } }, "additionalProperties": false }, "footer": { "description": "Footer for the capture component shown in the head flow. The '%index' and '%range' parameters are replaced internally with the numeric values depending on the current step of the process.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Paso %index de %range", "EN": "Step %index of %range" }, "$id": "captureHeadFooter" } }, "additionalProperties": false } }, "additionalProperties": false }, "selectCamera": { "description": "Selects by default the best front camera to capture and detect with the SDK.", "type": "string", "enum": ["front"], "default": "front", "$id": "selfieSelectCamera" }, "constraints": { "description": "Camera constraints input to customize the values.", "type": "object", "properties": { "video": { "description": "Video property main constraint.", "type": "object", "properties": { "height": { "description": "Video height property main constraint.", "type": "number", "enum": [1080], "default": 1080, "$id": "videoHeightSelfie" } }, "additionalProperties": false }, "audio": { "description": "If true, the microphone will be enabled.", "type": "boolean", "enum": [false], "default": false, "$id": "audioSelfie" } }, "additionalProperties": false }, "successTick": { "description": "Component that displays a success check once the capture has been successfully done.", "type": "object", "properties": { "show": { "description": "If true, displays the a success tick component when the capture process has been success.", "type": "boolean", "default": true, "$id": "selfieSuccessTickShow" }, "media": { "description": "Custom media file to be shown when success tick component is displayed. `IMPORTANT: if empty it will use default tick`", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "selfieSuccessTickMedia" } }, "additionalProperties": false }, "detectionTimeout": { "description": "Duration in milliseconds after which the SDK should stop recording and shut down. Max is 300000, min 60000.", "type": "number", "minimum": 60000, "maximum": 300000, "default": 300000, "$id": "selfieDetectionTimeout" }, "alternativeVideoRecorder": { "description": "If true, the alternative video recorder will be used in all devices.", "type": "boolean", "default": false, "$id": "selfieAlternativeVideoRecorder" } }, "additionalProperties": false }, "deviceRotated": { "type": "object", "properties": { "active": { "description": "If true, displays a device rotated component to inform the user.", "type": "boolean", "default": true, "$id": "selfieDeviceRotatedActive" }, "onOrientation": { "description": "Modifies the orientation in which the device rotated component appears.", "type": "string", "enum": ["landscape", "portrait"], "default": "landscape", "$id": "selfieOrientationMode" }, "card": { "type": "object", "properties": { "title": { "description": "Title for the device rotated component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Para continuar, coloque el teléfono en orientación VERTICAL", "EN": "To continue, put the phone in the VERTICAL orientation" }, "$id": "selfieDeviceRotatedTitle" }, "media": { "description": "Media for the device rotated component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/rotateMedia.gif", "default": "/images/rotateMedia.gif", "$id": "selfieDeviceRotatedMedia" }, "header": { "description": "Header to display a rotate device message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Aviso", "EN": "Disclaimer" }, "$id": "selfieDeviceRotatedHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "reviewImage": { "type": "object", "properties": { "active": { "description": "If true, displays a confirmation dialog component showing the captured image and gives the user the option to continue or repeat the capture process.", "type": "boolean", "default": false, "$id": "selfieReviewImageActive" }, "card": { "type": "object", "properties": { "header": { "description": "Header to display a review image message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Revisar imagen", "EN": "Image review" }, "$id": "selfieReviewImageHeader" }, "media": { "description": "Media for the review image component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/tick.png", "default": "/images/tick.png", "$id": "selfieReviewImageMedia" }, "title": { "description": "Title for the review image component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Asegúrese de que la cara se ve bien y tiene una expresión natural", "EN": "Make sure the face appears good and has a natural expression" }, "$id": "selfieReviewImageTitle" }, "buttons": { "type": "object", "properties": { "continue": { "type": "object", "properties": { "text": { "description": "Text for the continue button in the review image component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Continuar", "EN": "Continue" }, "$id": "reviewImageContinueButtonText" } }, "additionalProperties": false }, "repeat": { "type": "object", "properties": { "text": { "description": "Text for the repeat button in the review image component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Repetir", "EN": "Repeat" }, "$id": "reviewImageRepeatButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "feedback": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "validation": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the process is not successfully completed.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No se ha podido completar el proceso. Por favor, inténtelo de nuevo", "EN": "The process could not be completed. Please, try again" }, "$id": "errorValidationTitle" }, "header": { "description": "Header for the error component that shows when the process is not successfully completed.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error de validación", "EN": "Validation Error" }, "$id": "errorValidationHeader" }, "media": { "description": "Media for the validation error message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "errorValidationMedia" }, "buttons": { "type": "object", "properties": { "restart": { "type": "object", "properties": { "text": { "description": "Text for the button in the error component that shows when the process is not successfully completed.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Reintentar", "EN": "Try again" }, "$id": "errorValidationButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "orientationChangedRestartMessage": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the process is stopped by an orientation change.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No se ha podido completar el proceso debido a un cambio de orientación inesperado del dispositivo", "EN": "The process could not be completed due to an unexpected change in the device's orientation" }, "$id": "selfieOrientationChangedRestartMessageTitle" }, "media": { "description": "Media for the message in the error component that shows when the process is stopped by an orientation change.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "selfieOrientationChangedRestartMessageMedia" }, "header": { "description": "Header to display an orientation changed error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "selfieOrientationChangedRestartMessageHeader" }, "buttons": { "type": "object", "properties": { "restart": { "type": "object", "properties": { "text": { "description": "Text for the button in the error component that shows when the process is stopped by an orientation change.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Reintentar", "EN": "Try again" }, "$id": "selfieOrientationChangedRestartMessageButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorNotFound": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to user if media device is not found.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Por favor, compruebe que su dispositivo dispone de cámara", "EN": "Please check that your device has a camera" }, "$id": "selfieVideoErrorNotFoundTitle" }, "media": { "description": "Media image in the videoErrorNotFound description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "selfieVideoErrorNotFoundMedia" }, "header": { "description": "Header to display to user if media device is not found.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "selfieVideoErrorNotFoundHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorPermission": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to the user if camera device media or microphone does not have permission.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Por favor, asegúrese de permitir a la página acceso a la cámara y micrófono", "EN": "Please, make sure to allow the page access to the camera and microphone" }, "$id": "selfieVideoErrorPermissionTitle" }, "media": { "description": "Media image in the videoErrorPermission description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "selfieVideoErrorPermissionMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "selfieVideoErrorPermissionHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorDefault": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to user if there is a media default error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Lo sentimos, se ha producido un error al iniciar la cámara", "EN": "Sorry, there has been an error when initiating the camera" }, "$id": "selfieVideoErrorDefaultTitle" }, "media": { "description": "Media image in the videoErrorDefault description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "selfieVideoErrorDefaultMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "selfieVideoErrorDefaultHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "dependenciesErrorText": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to the user if there is a dependency error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Lo sentimos, se ha producido un error cargando las dependencias. Revise su configuración y compruebe la ruta de sus recursos", "EN": "Sorry, there has been an error when loading dependencies. Please, review your configuration and check the path of your resources" }, "$id": "selfieDependenciesErrorTextTitle" }, "media": { "description": "Media image in the dependenciesErrorText description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "selfieDependenciesErrorTextMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "selfieDependenciesErrorTextHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "pathAssets": { "description": "Location folder for all the assets given in the release package.", "type": "string", "default": "assets", "$id": "selfiePathAssets" } }, "additionalProperties": false }, "sdkDocument": { "type": "object", "description": "SDK Document configuration properties.", "properties": { "flowType": { "type": "object", "properties": { "documents": { "description": "Document string configuration using document or group id to be captured. Please check https://docs.veridas.com/document-sdk/html/latest/documents/ section to get more information.", "type": "string", "default": "ES2_ID", "$id": "documentType", "enum": [ "DNI20", "ES", "ES_ID", "XX", "XX_ID", "DNI30", "NIE2011", "IFE2002", "IFE2008", "MX", "MX_ID", "IFE2013", "IFEE", "NIE2003", "NIE2010", "Passport", "XX_Passport_YYYY", "MYS2001", "MY", "MY_ID", "ARG2009", "AR", "AR_ID", "ARG2012", "PE_IDCard_2020", "PE", "PE_ID", "PE_ResidencePermit_2017", "PE_IDCard_2013", "PE_IDCard_2007", "CO_IDCard_2000", "CO", "CO_ID", "CO_ResidencePermit_2016", "CL_IDCard_2002", "CL", "CL_ID", "CL_IDCard_2013", "VE_IDCard_2011", "VE", "VE_ID", "PY_IDCard_2007", "PY", "PY_ID", "PY_IDCard_2009", "PT_IDCard_2015", "PT", "PT_ID", "PT_DrivingLicense_2013", "PT_DL", "XX_DL", "DE_IDCard_2007", "DE", "DE_ID", "DE_IDCard_2010", "DE_DrivingLicense_2004", "DE_DL", "DE_DrivingLicense_2013", "BE_IDCard_2008", "BE", "BE_ID", "BE_IDCard_2010", "BE_IDCard_2021", "BE_DrivingLicense_2010", "BE_DL", "BE_DrivingLicense_2013", "FI_IDCard_2011", "FI", "FI_ID", "FI_IDCard_2017", "FI_DrivingLicense_2010", "FI_DL", "FI_DrivingLicense_1992", "FI_DrivingLicense_2013", "FR_IDCard_1994", "FR", "FR_ID", "FR_IDCard_2021", "FR_DrivingLicense_2013", "FR_DL", "NL_IDCard_2011", "NL", "NL_ID", "NL_IDCard_2014", "NL_DrivingLicense_2013", "NL_DL", "NL_DrivingLicense_2014", "NL_DrivingLicense_2006", "IT_IDCard_2004", "IT", "IT_ID", "IT_IDCard_2016", "IT_DrivingLicense_2000", "IT_DL", "IT_DrivingLicense_2013", "IT_IDCard_2017", "CH_IDCard_2003", "CH", "CH_ID", "CH_DrivingLicense_2003", "CH_DL", "AT_IDCard_2002", "AT_DrivingLicense_2006", "AT", "AT_DL", "AT_DrivingLicense_2014", "AT_IDCard_2010", "AT_ID", "AT_DrivingLicense_2004", "AT_ResidencePermit_2011", "AT_ResidencePermit_2005", "PL_IDCard_2001", "PL", "PL_ID", "PL_IDCard_2015", "PL_DrivingLicense_1999", "PL_DL", "PL_DrivingLicense_2013", "PL_DrivingLicense_2004", "RO_IDCard_2009", "RO", "RO_ID", "RO_IDCard_2021", "RO_DrivingLicense_2013", "RO_DL", "SE_IDCard_2012", "SE", "SE_ID", "SE_DrivingLicense_2016", "SE_DL", "BG_IDCard_2006", "BG", "BG_ID", "BG_IDCard_2010", "BG_DrivingLicense_2013", "BG_DL", "BG_DrivingLicense_2002", "HR_IDCard_2003", "HR", "HR_ID", "HR_IDCard_2015", "HR_DrivingLicense_2013", "HR_DL", "HU_IDCard_2000", "HU", "HU_ID", "HU_IDCard_2015", "HU_DrivingLicense_2013", "HU_DL", "GB_DrivingLicense_2015", "GB", "GB_DL", "GB_DrivingLicense_2007", "GB_DrivingLicense_1998", "GB_DrivingLicense_2014", "GB_DrivingLicense-PL_2015", "GB_DrivingLicense-PL_2007", "GB_DrivingLicense-PL_1998", "GB_DrivingLicense-PL_2014", "IE_Passport_2015", "IE", "IE_ID", "IE_DrivingLicense_2013", "IE_DL", "DK_DrivingLicense_1997", "DK", "DK_DL", "DK_DrivingLicense_2013", "IS_DrivingLicense_2001", "IS", "IS_DL", "IS_DrivingLicense_2013", "NO_DrivingLicense_1998", "NO_DrivingLicense_2007", "NO", "NO_DL", "NO_DrivingLicense_2013", "CZ_IDCard_2003", "CZ", "CZ_ID", "CZ_IDCard_2014", "CZ_DrivingLicense_2013", "CZ_DL", "SK_IDCard_2015", "SK", "SK_ID", "SK_DrivingLicense_2008", "SK_DL", "SK_DrivingLicense_2013", "UA_IDCard_2016", "UA", "UA_ID", "CY_IDCard_2008", "CY", "CY_ID", "CY_IDCard_2015", "CY_DrivingLicense_2015", "CY_DL", "SI_IDCard_1998", "SI", "SI_ID", "SI_DrivingLicense_2013", "SI_DL", "SI_DrivingLicense_2009", "GR_DrivingLicense_2013", "GR", "GR_DL", "ES_DrivingLicense_2013", "ES2", "ES2_DL", "ES_DL", "ES_DrivingLicense_2004", "EE_IDCard_2011", "EE", "EE_ID", "EE_DrivingLicense_2004", "EE_DL", "EE_DrivingLicense_2013", "LV_IDCard_2012", "LV", "LV_ID", "LT_IDCard_2002", "LT", "LT_ID", "LT_IDCard_2009", "BA_IDCard_2003", "BA", "BA_ID", "BA_IDCard_2013", "ME_IDCard_2008", "ME", "ME_ID", "LI_IDCard_1995", "LI", "LI_ID", "LI_IDCard_2009", "LI_DrivingLicense_2003", "LI_DL", "AL_IDCard_2009", "AL", "AL_ID", "MD_IDCard_2015", "MD", "MD_ID", "MK_IDCard_2007", "MK", "MK_ID", "RS_IDCard_2008", "RS", "RS_ID", "MC_IDCard_2009", "MC", "MC_ID", "LU_IDCard_2014", "LU", "LU_ID", "LU_DrivingLicense_2013", "LU_DL", "MT_IDCard_2002", "MT", "MT_ID", "MT_IDCard_2014", "MT_DrivingLicense_2003", "MT_DL", "MT_DrivingLicense_2013", "LV_DrivingLicense_2004", "LV_DL", "LV_DrivingLicense_2013", "LT_DrivingLicense_2016", "LT_DL", "LT_DrivingLicense_2007", "BY_DrivingLicense_2010", "BY", "BY_DL", "AD_DrivingLicense_1990", "AD", "AD_DL", "US-SC_DrivingLicense_2018", "US", "US-SC", "US-SC_DL", "US_DL", "US-SC_DrivingLicense_2011", "US-LA_DrivingLicense_2016", "US-LA", "US-LA_DL", "US-LA_DrivingLicense_2014", "US-LA_DrivingLicense_2011", "US-AR_DrivingLicense_2016", "US-AR", "US-AR_DL", "US-AR_DrivingLicense_2018", "US-GA_DrivingLicense_2012", "US-GA", "US-GA_DL", "US-GA_DrivingLicense_2007", "US-NC_DrivingLicense_2017", "US-NC", "US-NC_DL", "US-NC_DrivingLicense_2007", "US-CO_DrivingLicense_2016", "US-CO", "US-CO_DL", "US-CO_DrivingLicense_2011", "US-AZ_DrivingLicense_2016", "US-AZ", "US-AZ_DL", "US-AZ_DrivingLicense_2004", "US-AZ_DrivingLicense_1996", "US-AZ_DrivingLicense_1990", "US-MS_DrivingLicense_2017", "US-MS", "US-MS_DL", "US-MS_DrivingLicense_2001", "US-AL_DrivingLicense_2013", "US-AL", "US-AL_DL", "US-AL_IDCard_2013", "US-AL_ID", "US_ID", "US-KS_DrivingLicense_2017", "US-KS", "US-KS_DL", "US-KS_DrivingLicense_2004", "US-OK_DrivingLicense_2018", "US-OK", "US-OK_DL", "US-TX_DrivingLicense_2016", "US-TX", "US-TX_DL", "US-TX_IDCard_2016", "US-TX_ID", "US-NM_DrivingLicense_2016", "US-NM", "US-NM_DL", "US-NM_DrivingLicense_2014", "US-CA_DrivingLicense_2018", "US-CA", "US-CA_DL", "US-NV_DrivingLicense_2014", "US-NV", "US-NV_DL", "US-FL_DrivingLicense_2017", "US-FL", "US-FL_DL", "US-CT_DrivingLicense_2017", "US-CT", "US-CT_DL", "XX_XX_XXXX", "ES_IDCard_2015", "ES2_ID", "ES_IDCard_2006", "ES_ResidencePermit_2010", "ES_ResidencePermit_2011", "ES_ResidencePermit_2020", "MX_IDCard_2013", "MX_IDCard_2014", "MX2", "MX2_ID", "MX_IDCard_2008", "MX_IDCard_2019", "MX_ResidencePermit_2010", "AR_IDCard_2009", "AR2", "AR2_ID", "AR_IDCard_2012", "US-HI_DrivingLicense_2012", "US-HI", "US-HI_DL", "US-HI_DrivingLicense_2018", "US-ME_DrivingLicense_2011", "US-ME", "US-ME_DL", "US-IL_DrivingLicense_2016", "US-IL", "US-IL_DL", "US-IL_DrivingLicense_2007", "US-ID_DrivingLicense_2010", "US-ID", "US-ID_DL", "US-ID_DrivingLicense_2017", "US-ID_DrivingLicense_2004", "US-MD_DrivingLicense_2016", "US-MD", "US-MD_DL", "US-MD_DrivingLicense_2013", "US-MI_DrivingLicense_2017", "US-MI", "US-MI_DL", "US-TN_DrivingLicense_2012", "US-TN", "US-TN_DL", "US-TN_DrivingLicense_2003", "US-DC_DrivingLicense_2017", "US-DC", "US-DC_DL", "US-MA_DrivingLicense_2018", "US-MA", "US-MA_DL", "US-MA_DrivingLicense_2010", "US-AK_DrivingLicense_2014", "US-AK", "US-AK_DL", "US-AK_DrivingLicense_2018", "US-AK_DrivingLicense_2005", "US-IN_DrivingLicense_2010", "US-IN", "US-IN_DL", "US-IN_DrivingLicense_2017", "US-NE_DrivingLicense_2013", "US-NE", "US-NE_DL", "US-NH_DrivingLicense_2017", "US-NH", "US-NH_DL", "US-NH_DrivingLicense_2006", "US-NY_DrivingLicense_2017", "US-NY", "US-NY_DL", "US-NY_DrivingLicense_2008", "US-OH_DrivingLicense_2018", "US-OH", "US-OH_DL", "US-OH_DrivingLicense_2014", "US-OH_DrivingLicense_2013", "US-WV_DrivingLicense_2013", "US-WV", "US-WV_DL", "US-WV_DrivingLicense_2005", "US-UT_DrivingLicense_2016", "US-UT", "US-UT_DL", "US-UT_DrivingLicense_2006", "US-RI_DrivingLicense_2018", "US-RI", "US-RI_DL", "US-SD_DrivingLicense_2010", "US-SD", "US-SD_DL", "US-WI_DrivingLicense_2015", "US-WI", "US-WI_DL", "US-WI_DrivingLicense_2005", "US-PA_DrivingLicense_2017", "US-PA", "US-PA_DL", "US-PA_DrivingLicense_2011", "US-VT_DrivingLicense_2014", "US-VT", "US-VT_DL", "US-VT_DrivingLicense_2018", "US-VA_DrivingLicense_2018", "US-VA", "US-VA_DL", "US-VA_IDCard_2018", "US-VA_ID", "US-WY_DrivingLicense_2014", "US-WY", "US-WY_DL", "US-WA_DrivingLicense_2017", "US-WA", "US-WA_DL", "US-WA_DrivingLicense_2019", "US-WA_DrivingLicense_2010", "US-MO_DrivingLicense_2012", "US-MO", "US-MO_DL", "US-MO_DrivingLicense_2004", "US-MT_DrivingLicense_2000", "US-MT", "US-MT_DL", "US-MT_DrivingLicense_2008", "GT_IDCard_2009", "GT", "GT_ID", "AU-WA_DrivingLicense_2014", "AU", "AU-WA", "AU-WA_DL", "AU_DL", "AU-TAS_DrivingLicense_2015", "AU-TAS", "AU-TAS_DL", "AU-QLD_DrivingLicense_2016", "AU-QLD", "AU-QLD_DL", "AU-QLD_DrivingLicense_2011", "AU-NT_DrivingLicense_2006", "AU-NT", "AU-NT_DL", "AU-NSW_DrivingLicense_2013", "AU-NSW", "AU-NSW_DL", "AU-SA_DrivingLicense_2014", "AU-SA", "AU-SA_DL", "AU-VIC_DrivingLicense_2009", "AU-VIC", "AU-VIC_DL", "AU-ACT_DrivingLicense_2011", "AU-ACT", "AU-ACT_DL", "AU-WA_DrivingLicense_2011", "CA-AB_DrivingLicense_2009", "CA", "CA-AB", "CA-AB_DL", "CA_DL", "CA-AB_IDCard_2018", "CA-AB_ID", "CA_ID", "CA-QC_DrivingLicense_2015", "CA-QC", "CA-QC_DL", "CA-SK_DrivingLicense_2016", "CA-SK", "CA-SK_DL", "CA-SK_IDCard_2014", "CA-SK_ID", "CA-YT_DrivingLicense_2010", "CA-YT", "CA-YT_DL", "CA-PE_DrivingLicense_2017", "CA-PE", "CA-PE_DL", "CA-ON_DrivingLicense_2007", "CA-ON", "CA-ON_DL", "CA-ON_IDCard_2011", "CA-ON_ID", "CA-NU_DrivingLicense_2009", "CA-NU", "CA-NU_DL", "CA-MB_DrivingLicense_2014", "CA-MB", "CA-MB_DL", "CA-NS_DrivingLicense_2017", "CA-NS", "CA-NS_DL", "CA-NB_DrivingLicense_2017", "CA-NB", "CA-NB_DL", "UY_IDCard_1999", "UY", "UY_ID", "UY_IDCard_2015", "TR_IDCard_2016", "TR", "TR_ID", "RU_DrivingLicense_2011", "RU", "RU_DL", "US-CT_DrivingLicense_2009", "US-KS_DrivingLicense_2012", "US-DE_DrivingLicense_2010", "US-DE", "US-DE_DL", "US-IA_DrivingLicense_2013", "US-IA", "US-IA_DL", "US-IA_DrivingLicense_2018", "US-FL_DrivingLicense_2010", "US-CA_DrivingLicense_2008", "US-RI_DrivingLicense_2008", "US-WI_DrivingLicense_2012", "US-MN_DrivingLicense_2004", "US-MN", "US-MN_DL", "US-MN_DrivingLicense_2018", "PL_IDCard_2019", "NZ_DrivingLicense_2007", "NZ", "NZ_DL", "SE_DrivingLicense_2013", "PT_DrivingLicense_1999", "CA-NT_DrivingLicense_2005", "CA-NT", "CA-NT_DL", "CA-NB_IDCard_2020", "CA-NB_ID", "CA-NL_DrivingLicense_2017", "CA-NL", "CA-NL_DL", "CA-BC_DrivingLicense_2013", "CA-BC", "CA-BC_DL", "CA-BC_IDCard_2009", "CA-BC_ID", "CA-BC_IDCard_2013", "CN_IDCard_2004", "CN", "CN_ID", "BR_DrivingLicense_2017", "BR", "BR_DL", "BR_DrivingLicense_2019", "BR_IDCard_2014", "BR_ID", "US-DE_DrivingLicense_2018", "US-KY_DrivingLicense_2019", "US-KY", "US-KY_DL", "US-KY_DrivingLicense_2012", "US-NJ_DrivingLicense_2011", "US-NJ", "US-NJ_DL", "US-OR_DrivingLicense_2018", "US-OR", "US-OR_DL", "US-OR_DrivingLicense_2007", "US-ND_DrivingLicense_2018", "US-ND", "US-ND_DL", "US-ND_DrivingLicense_2006", "PA_IDCard_2010", "PA", "PA_ID", "MY_IDCard_2012", "DO_IDCard_1998", "DO", "DO_ID", "DO_IDCard_2014", "US_IDCard-MilitaryRS_1993", "US-AK_ID", "US-AR_ID", "US-AZ_ID", "US-CA_ID", "US-CO_ID", "US-CT_ID", "US-DC_ID", "US-DE_ID", "US-FL_ID", "US-GA_ID", "US-HI_ID", "US-IA_ID", "US-ID_ID", "US-IL_ID", "US-IN_ID", "US-KS_ID", "US-KY_ID", "US-LA_ID", "US-MA_ID", "US-MD_ID", "US-ME_ID", "US-MI_ID", "US-MN_ID", "US-MO_ID", "US-MS_ID", "US-MT_ID", "US-NC_ID", "US-ND_ID", "US-NE_ID", "US-NH_ID", "US-NJ_ID", "US-NM_ID", "US-NV_ID", "US-NY_ID", "US-OH_ID", "US-OK_ID", "US-OR_ID", "US-PA_ID", "US-RI_ID", "US-SC_ID", "US-SD_ID", "US-TN_ID", "US-UT_ID", "US-VT_ID", "US-WA_ID", "US-WI_ID", "US-WV_ID", "US-WY_ID", "US_IDCard-MilitaryRT_1993", "US_IDCard-MilitaryRR_1993", "PH_DrivingLicense_2017", "PH", "PH_DL", "PH_IDCard_2011", "PH_ID", "PH_IDCard_2015", "PH_IDCard_2016", "PH_IDCard-PO_2016", "SG_IDCard_2011", "SG", "SG_ID", "IT_HealthCard_2004", "IT_HC", "XX_HC", "CO_IDCard_2020", "US_ResidencePermit_2017", "NO_IDCard_2020", "NO_ID", "ES_IDCard_2021", "ES_ResidencePermit_2007", "AT_ResidencePermit_2020", "RU_IDCard_2007", "RU_ID", "AT_IDCard_2021", "GB_DrivingLicense_2021", "DE_IDCard_2021", "FI_IDCard_2021", "CY_IDCard_2021", "PT_ResidencePermit_2017", "PT_ResidencePermit_2019", "CA-MB_IDCard_2009", "CA-MB_ID", "MX_ProfessionalCard_2008", "MX2_PC", "XX_PC", "AD_ResidencePermit_2018", "AD_ID", "FR_DrivingLicense_2006", "EC_IDCard_2009", "EC", "EC_ID", "AM_IDCard_2012", "AM", "AM_ID", "ZA_DrivingLicense_2004", "ZA", "ZA_DL", "ZA_IDCard_2013", "ZA_ID", "GB_DrivingLicense_2022", "GB_DrivingLicense_2012", "PT_ResidencePermit_2020", "IT_HealthCard_2022", "GB_ResidencePermit_2015", "GB_ID", "GB_ResidencePermit_2021", "HR_IDCard_2021", "PT_DrivingLicense_2021", "XX_MRZType1_YYYY", "PE_ResidencePermit_2021", "CA-AB_DrivingLicense_2018", "IT_IDCard_2022" ] } }, "additionalProperties": false }, "views": { "type": "object", "properties": { "instructions": { "type": "object", "properties": { "active": { "description": "If true, displays a instructions component to inform the user.", "type": "boolean", "default": true, "$id": "documentInstructionsActive" }, "header": { "type": "object", "properties": { "title": { "description": "Title of the instructions component.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Antes de comenzar el proceso, lea estas sencillas instrucciones" ], "EN": [ "Before starting the process, read these simple instructions" ] }, "$id": "documentInstructionsMainHeader" } }, "additionalProperties": false }, "card": { "type": "object", "properties": { "title": { "type": "object", "properties": { "documents": { "description": "List of titles in document flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "La captura se tomará automáticamente" ], "EN": [ "The capture will be taken automatically" ] }, "$id": "documentInstructionsTitle" } }, "additionalProperties": false }, "subtitle": { "type": "object", "properties": { "documents": { "description": "List of subtitles in document flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "1. Asegúrese de que todos los datos del documento estén visibles, y de que no hay brillos o sombras. \n 2. Cuando el documento esté enfocado, la captura se tomará automáticamente" ], "EN": [ "1. Ensure all document data is visible, and there are no glares or shadows. \n 2. Once the document is in focus, the capture will be taken automatically " ] }, "$id": "documentInstructionSubTitle" } }, "additionalProperties": false }, "media": { "type": "object", "properties": { "documents": { "description": "List of media in document flow for the instructions slides.", "vdTypes": "fetchable", "type": "array", "legacyPathMedia": [ "/images/document1.svg", "/images/document2.svg" ], "default": [ "/images/document1.svg", "/images/document2.svg" ], "$id": "documentInstructionsMedia" } }, "additionalProperties": false }, "header": { "description": "Header to Instructions.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Instrucciones", "EN": "Instructions" }, "$id": "documentInstructionsHeader" }, "buttons": { "type": "object", "properties": { "next": { "type": "object", "properties": { "media": { "description": "Media for next button in the instructions component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrow-right.svg", "default": "/images/arrow-right.svg", "$id": "documentInstructionsButtonNextMedia" }, "text": { "description": "Text for next button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Siguiente", "EN": "Next" }, "$id": "documentInstructionsButtonNextText" } }, "additionalProperties": false }, "previous": { "type": "object", "properties": { "media": { "description": "Media for previous button in the instructions component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrow-left.svg", "default": "/images/arrow-left.svg", "$id": "documentInstructionsButtonPrevMedia" }, "text": { "description": "Text for previous button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Anterior", "EN": "Previous" }, "$id": "documentInstructionsButtonPrevText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "progressIndicator": { "type": "object", "properties": { "show": { "description": "If true, displays the progress indicator component.", "type": "boolean", "default": true, "$id": "documentInstructionsProgressIndicator" } }, "additionalProperties": false }, "buttons": { "type": "object", "properties": { "startProcess": { "type": "object", "properties": { "text": { "description": "Text for continue button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "EN": "Start", "ES": "Comenzar" }, "$id": "documentInstructionsButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "capture": { "type": "object", "properties": { "positionGuides": { "description": "Guides used to indicate the end user that the document has been detected in the 'x' and 'y' position.", "type": "object", "properties": { "colors": { "description": "Colors from each guide. You can configure it in two ways: By declaring just one color and every guide will be from that color or by specifying each guide color based on the number of guides 'num' specified. IE. If 'num' is 3, you have to configure exactly 3 colors.", "type": "array", "items": { "type": "string", "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$" }, "default": [ "#000D44", "#000D44", "#000D44", "#000D44", "#000D44" ], "$id": "positionGuides" }, "num": { "description": "Number of guides to be shown on each corner once the document has been detected. The Maximum number of guides is 5.", "type": "number", "minimum": 1, "maximum": 5, "default": 5, "$id": "positionGuidesNum" } }, "additionalProperties": false }, "guidance": { "type": "object", "properties": { "preCapture": { "type": "object", "properties": { "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display pre capture message.", "type": "string", "default": "Capture", "$id": "preCaptureObverseHeader" }, "title": { "description": "Title of the capture component that shows the steps to take a photo of the document.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Muestre la parte DELANTERA del documento", "EN": "Show the FRONT side of the document" }, "$id": "preCaptureObverseTitle" }, "media": { "description": "Media for the capture component that shows the steps to take a photo of the document.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "preCaptureObverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display pre capture message.", "type": "string", "default": "Capture", "$id": "preCaptureReverseHeader" }, "title": { "description": "Title of the capture component that shows the steps to take a photo of the document.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Muestre la parte TRASERA del documento", "EN": "Show the BACK side of the document" }, "$id": "preCaptureReverseTitle" }, "media": { "description": "Media for the capture component that shows the steps to take a photo of the document.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "preCaptureReverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display capture message.", "type": "string", "default": "Capture", "$id": "captureObverseHeader" }, "title": { "description": "Title indicating how to capture a photo.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Capturando ...", "EN": "Capturing ..." }, "$id": "captureObverseTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "captureObverseMedia" } }, "additionalProperties": false }, "additionalProperties": false }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display capture message.", "type": "string", "default": "Capture", "$id": "captureReverseHeader" }, "title": { "description": "Title indicating how to capture a photo.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Capturando ...", "EN": "Capturing ..." }, "$id": "captureReverseTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "captureReverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "documentNotFound": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display document not found message.", "type": "string", "default": "Instructions", "$id": "documentNotFoundHeader" }, "title": { "description": "Title indicating how to capture a photo manually.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No se ha podido detectar el documento. Por favor, colóquelo en el recuadro", "EN": "The document could not be detected. Please, place it within the box" }, "$id": "documentNotFoundTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "documentNotFoundMedia" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "manualCapture": { "type": "object", "properties": { "active": { "description": "If true, the manual capture document is accesible to capture manually.", "type": "boolean", "default": true, "$id": "manualCaptureActive" }, "manualCaptureButtonDelay": { "description": "Time used to capture the document automatically.", "type": "number", "minimum": 1000, "default": 6000, "$id": "manualCaptureButtonDelay" }, "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display capture manual message.", "type": "string", "default": "Instructions", "$id": "manualCaptureObverseHeader" }, "title": { "description": "Title indicating how to manual capture a photo.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Pulse para capturar la parte DELANTERA", "EN": "Tap to capture the FRONT side of the document" }, "$id": "manualCaptureObverseTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "manualCaptureObverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display capture manual message.", "type": "string", "default": "Instructions", "$id": "manualCaptureReverseHeader" }, "title": { "description": "Title indicating how to manual capture a photo.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Pulse para capturar la parte TRASERA", "EN": "Tap to capture the BACK side of the document" }, "$id": "manualCaptureReverseTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "manualCaptureReverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "buttons": { "type": "object", "properties": { "captureButton": { "type": "object", "properties": { "media": { "description": "List of media in document flow for the manual capture.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "manualCaptureButtonMedia" }, "text": { "description": "Text for capture button in the button capture component.", "vdTypes": "translatable", "type": "string", "default": { "EN": "Take picture", "ES": "Hacer Foto" }, "$id": "manualCaptureButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "tooFar": { "type": "object", "properties": { "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display too far message.", "type": "string", "default": "Capture", "$id": "tooFarObverseHeader" }, "title": { "description": "Title indicating that the document is too far away.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Acerque el documento", "EN": "Zoom in the document" }, "$id": "tooFarObverseTitle" }, "media": { "description": "Media for the card component that the document is too far away.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "tooFarObverseMedia" } }, "additionalProperties": false }, "additionalProperties": false }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display too far message.", "type": "string", "default": "Capture", "$id": "tooFarReverseHeader" }, "title": { "description": "Title indicating that the document is too far away.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Acerque el documento", "EN": "Zoom in the document" }, "$id": "tooFarReverseTitle" }, "media": { "description": "Media for the card component that the document is too far away.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "tooFarReverseMedia" } }, "additionalProperties": false }, "additionalProperties": false }, "additionalProperties": false } }, "additionalProperties": false }, "flipFrameAnimation": { "type": "object", "properties": { "active": { "description": "If true it will make an animation.", "type": "boolean", "default": true, "$id": "flipFrameAnimation" } }, "additionalProperties": false }, "selectCamera": { "description": "Selects by default the best back camera to capture and detect with the SDK.", "type": "string", "enum": ["back"], "default": "back", "$id": "documentSelectCamera" }, "constraints": { "description": "Camera constraints input to customize the values.", "type": "object", "properties": { "video": { "description": "Video property main constraint.", "type": "object", "properties": { "height": { "description": "Video height property main constraint.", "type": "number", "enum": [1080], "default": 1080, "$id": "videoHeightDocument" } }, "additionalProperties": false }, "audio": { "description": "If true, the microphone will be enabled.", "type": "boolean", "enum": [false], "default": false, "$id": "audioDocument" } }, "additionalProperties": false }, "successTick": { "description": "Component that displays a success check once the capture has been successfully done.", "type": "object", "properties": { "show": { "description": "If true, displays the a success tick component when the capture process has been success.", "type": "boolean", "default": true, "$id": "documentSuccessTickShow" }, "media": { "description": "Custom media file to be shown when success tick component is displayed. `IMPORTANT: if empty it will use default tick`", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "documentSuccessTickMedia" } }, "additionalProperties": false }, "detectionTimeout": { "description": "Duration in milliseconds after which the SDK should stop recording and shut down. Max is 300000, min 60000.", "type": "number", "minimum": 60000, "maximum": 300000, "default": 300000, "$id": "documentDetectionTimeout" }, "alternativeVideoRecorder": { "description": "If true, the alternative video recorder will be used in all devices.", "type": "boolean", "default": false, "$id": "documentAlternativeVideoRecorder" } }, "additionalProperties": false }, "deviceRotated": { "type": "object", "properties": { "active": { "description": "If true, displays a device rotated component to inform the user.", "type": "boolean", "default": false, "$id": "documetDeviceRotatedActive" }, "onOrientation": { "description": "Modifies the orientation in which the device rotated component appears.", "type": "string", "enum": ["landscape", "portrait"], "default": "portrait", "$id": "documentOrientationMode" }, "card": { "type": "object", "properties": { "title": { "description": "Title for the device rotated component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Para continuar, coloque el teléfono en orientación HORIZONTAL", "EN": "To continue, put the phone in the HORIZONTAL orientation" }, "$id": "documentDeviceRotatedTitle" }, "media": { "description": "Media for the device rotated component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/landscapePlease.gif", "default": "/images/landscapePlease.gif", "$id": "documentDeviceRotatedMedia" }, "header": { "description": "Header to display Rotate device.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Aviso", "EN": "Disclaimer" }, "$id": "documentDeviceRotatedHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "reviewImage": { "type": "object", "properties": { "active": { "description": "If true, displays a confirmation dialog component showing the captured image and gives the user the option to continue or repeat the capture process.", "type": "boolean", "default": true, "$id": "documentReviewImageActive" }, "card": { "type": "object", "properties": { "header": { "description": "Header to display a review image message.", "type": "string", "default": "Review image", "$id": "documentReviewImageHeader" }, "media": { "description": "Media for the review image component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/tick.png", "default": "/images/tick.png", "$id": "documentReviewImageMedia" }, "title": { "description": "Title for the review image component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Compruebe que el documento está bien enfocado y es legible", "EN": "Make sure the document is well-focused and legible" }, "$id": "documentReviewImageTitle" }, "buttons": { "type": "object", "properties": { "continue": { "type": "object", "properties": { "text": { "description": "Text for the continue button in the review image component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Continuar", "EN": "Continue" }, "$id": "reviewImageButtonContinueText" } }, "additionalProperties": false }, "repeat": { "type": "object", "properties": { "text": { "description": "Text for the repeat button in the review image component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Repetir", "EN": "Repeat" }, "$id": "reviewImageButtonRepeatText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "feedback": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "orientationChangedRestartMessage": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the process is stopped by an orientation change.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No se ha podido completar el proceso debido a un cambio de orientación inesperado del dispositivo", "EN": "The process could not be completed due to an unexpected change in the device's orientation" }, "$id": "documentOrientationChangedRestartMessageTitle" }, "media": { "description": "Media for the message in the error component that shows when the process is stopped by an orientation change.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "documentOrientationChangedRestartMessageMedia" }, "header": { "description": "Header to display Error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "documentOrientationChangedRestartMessageHeader" }, "buttons": { "type": "object", "properties": { "restart": { "type": "object", "properties": { "text": { "description": "Text for the button in the error component that shows when the process is stopped by an orientation change.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Reintentar", "EN": "Try again" }, "$id": "documentOrientationChangedRestartMessageButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorNotFound": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to user if media device is not found.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Por favor, compruebe que su dispositivo dispone de cámara", "EN": "Please check that your device has a camera" }, "$id": "documentVideoErrorNotFoundTitle" }, "media": { "description": "Media image in the videoErrorNotFound description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "documentVideoErrorNotFoundMedia" }, "header": { "description": "Header to display to user if media device is not found.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "documentVideoErrorNotFoundHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorPermission": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to the user if camera device media or microphone does not have permission.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Por favor, asegúrese de permitir a la página acceso a la cámara y micrófono", "EN": "Please, make sure to allow the page access to the camera and microphone" }, "$id": "documentVideoErrorPermissionTitle" }, "media": { "description": "Media image in the videoErrorPermission description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "documentVideoErrorPermissionMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "documentVideoErrorPermissionHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorDefault": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to user if there is a media default error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Lo sentimos, se ha producido un error al iniciar la cámara", "EN": "Sorry, there has been an error when initiating the camera" }, "$id": "documentVideoErrorDefaultTitle" }, "media": { "description": "Media image in the videoErrorDefault description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "documentVideoErrorDefaultMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "documentVideoErrorDefaultHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "dependenciesErrorText": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to the user if there is a dependency error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Lo sentimos, se ha producido un error cargando las dependencias. Revise su configuración y compruebe la ruta de sus recursos", "EN": "Sorry, there has been an error when loading dependencies. Please, review your configuration and check the path of your resources" }, "$id": "documentDependenciesErrorTextTitle" }, "media": { "description": "Media image in the dependenciesErrorText description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "documentDependenciesErrorTextMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "documentDependenciesErrorTextHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "pathAssets": { "description": "Location folder for all the assets given in the release package.", "type": "string", "default": "assets", "$id": "documentPathAssets" } }, "additionalProperties": false }, "sdkVideo": { "type": "object", "description": "SDK Video configuration properties.", "properties": { "flowType": { "type": "object", "properties": { "documents": { "description": "Document string configuration using document or group id to be captured. Please check https://docs.veridas.com/document-sdk/html/latest/documents/ section to get more information.", "type": "string", "default": "ES2_ID", "$id": "videoDocumentType", "enum": [ "DNI20", "ES", "ES_ID", "XX", "XX_ID", "DNI30", "NIE2011", "IFE2002", "IFE2008", "MX", "MX_ID", "IFE2013", "IFEE", "NIE2003", "NIE2010", "Passport", "XX_Passport_YYYY", "MYS2001", "MY", "MY_ID", "ARG2009", "AR", "AR_ID", "ARG2012", "PE_IDCard_2020", "PE", "PE_ID", "PE_ResidencePermit_2017", "PE_IDCard_2013", "PE_IDCard_2007", "CO_IDCard_2000", "CO", "CO_ID", "CO_ResidencePermit_2016", "CL_IDCard_2002", "CL", "CL_ID", "CL_IDCard_2013", "VE_IDCard_2011", "VE", "VE_ID", "PY_IDCard_2007", "PY", "PY_ID", "PY_IDCard_2009", "PT_IDCard_2015", "PT", "PT_ID", "PT_DrivingLicense_2013", "PT_DL", "XX_DL", "DE_IDCard_2007", "DE", "DE_ID", "DE_IDCard_2010", "DE_DrivingLicense_2004", "DE_DL", "DE_DrivingLicense_2013", "BE_IDCard_2008", "BE", "BE_ID", "BE_IDCard_2010", "BE_IDCard_2021", "BE_DrivingLicense_2010", "BE_DL", "BE_DrivingLicense_2013", "FI_IDCard_2011", "FI", "FI_ID", "FI_IDCard_2017", "FI_DrivingLicense_2010", "FI_DL", "FI_DrivingLicense_1992", "FI_DrivingLicense_2013", "FR_IDCard_1994", "FR", "FR_ID", "FR_IDCard_2021", "FR_DrivingLicense_2013", "FR_DL", "NL_IDCard_2011", "NL", "NL_ID", "NL_IDCard_2014", "NL_DrivingLicense_2013", "NL_DL", "NL_DrivingLicense_2014", "NL_DrivingLicense_2006", "IT_IDCard_2004", "IT", "IT_ID", "IT_IDCard_2016", "IT_DrivingLicense_2000", "IT_DL", "IT_DrivingLicense_2013", "IT_IDCard_2017", "CH_IDCard_2003", "CH", "CH_ID", "CH_DrivingLicense_2003", "CH_DL", "AT_IDCard_2002", "AT_DrivingLicense_2006", "AT", "AT_DL", "AT_DrivingLicense_2014", "AT_IDCard_2010", "AT_ID", "AT_DrivingLicense_2004", "AT_ResidencePermit_2011", "AT_ResidencePermit_2005", "PL_IDCard_2001", "PL", "PL_ID", "PL_IDCard_2015", "PL_DrivingLicense_1999", "PL_DL", "PL_DrivingLicense_2013", "PL_DrivingLicense_2004", "RO_IDCard_2009", "RO", "RO_ID", "RO_IDCard_2021", "RO_DrivingLicense_2013", "RO_DL", "SE_IDCard_2012", "SE", "SE_ID", "SE_DrivingLicense_2016", "SE_DL", "BG_IDCard_2006", "BG", "BG_ID", "BG_IDCard_2010", "BG_DrivingLicense_2013", "BG_DL", "BG_DrivingLicense_2002", "HR_IDCard_2003", "HR", "HR_ID", "HR_IDCard_2015", "HR_DrivingLicense_2013", "HR_DL", "HU_IDCard_2000", "HU", "HU_ID", "HU_IDCard_2015", "HU_DrivingLicense_2013", "HU_DL", "GB_DrivingLicense_2015", "GB", "GB_DL", "GB_DrivingLicense_2007", "GB_DrivingLicense_1998", "GB_DrivingLicense_2014", "GB_DrivingLicense-PL_2015", "GB_DrivingLicense-PL_2007", "GB_DrivingLicense-PL_1998", "GB_DrivingLicense-PL_2014", "IE_Passport_2015", "IE", "IE_ID", "IE_DrivingLicense_2013", "IE_DL", "DK_DrivingLicense_1997", "DK", "DK_DL", "DK_DrivingLicense_2013", "IS_DrivingLicense_2001", "IS", "IS_DL", "IS_DrivingLicense_2013", "NO_DrivingLicense_1998", "NO_DrivingLicense_2007", "NO", "NO_DL", "NO_DrivingLicense_2013", "CZ_IDCard_2003", "CZ", "CZ_ID", "CZ_IDCard_2014", "CZ_DrivingLicense_2013", "CZ_DL", "SK_IDCard_2015", "SK", "SK_ID", "SK_DrivingLicense_2008", "SK_DL", "SK_DrivingLicense_2013", "UA_IDCard_2016", "UA", "UA_ID", "CY_IDCard_2008", "CY", "CY_ID", "CY_IDCard_2015", "CY_DrivingLicense_2015", "CY_DL", "SI_IDCard_1998", "SI", "SI_ID", "SI_DrivingLicense_2013", "SI_DL", "SI_DrivingLicense_2009", "GR_DrivingLicense_2013", "GR", "GR_DL", "ES_DrivingLicense_2013", "ES2", "ES2_DL", "ES_DL", "ES_DrivingLicense_2004", "EE_IDCard_2011", "EE", "EE_ID", "EE_DrivingLicense_2004", "EE_DL", "EE_DrivingLicense_2013", "LV_IDCard_2012", "LV", "LV_ID", "LT_IDCard_2002", "LT", "LT_ID", "LT_IDCard_2009", "BA_IDCard_2003", "BA", "BA_ID", "BA_IDCard_2013", "ME_IDCard_2008", "ME", "ME_ID", "LI_IDCard_1995", "LI", "LI_ID", "LI_IDCard_2009", "LI_DrivingLicense_2003", "LI_DL", "AL_IDCard_2009", "AL", "AL_ID", "MD_IDCard_2015", "MD", "MD_ID", "MK_IDCard_2007", "MK", "MK_ID", "RS_IDCard_2008", "RS", "RS_ID", "MC_IDCard_2009", "MC", "MC_ID", "LU_IDCard_2014", "LU", "LU_ID", "LU_DrivingLicense_2013", "LU_DL", "MT_IDCard_2002", "MT", "MT_ID", "MT_IDCard_2014", "MT_DrivingLicense_2003", "MT_DL", "MT_DrivingLicense_2013", "LV_DrivingLicense_2004", "LV_DL", "LV_DrivingLicense_2013", "LT_DrivingLicense_2016", "LT_DL", "LT_DrivingLicense_2007", "BY_DrivingLicense_2010", "BY", "BY_DL", "AD_DrivingLicense_1990", "AD", "AD_DL", "US-SC_DrivingLicense_2018", "US", "US-SC", "US-SC_DL", "US_DL", "US-SC_DrivingLicense_2011", "US-LA_DrivingLicense_2016", "US-LA", "US-LA_DL", "US-LA_DrivingLicense_2014", "US-LA_DrivingLicense_2011", "US-AR_DrivingLicense_2016", "US-AR", "US-AR_DL", "US-AR_DrivingLicense_2018", "US-GA_DrivingLicense_2012", "US-GA", "US-GA_DL", "US-GA_DrivingLicense_2007", "US-NC_DrivingLicense_2017", "US-NC", "US-NC_DL", "US-NC_DrivingLicense_2007", "US-CO_DrivingLicense_2016", "US-CO", "US-CO_DL", "US-CO_DrivingLicense_2011", "US-AZ_DrivingLicense_2016", "US-AZ", "US-AZ_DL", "US-AZ_DrivingLicense_2004", "US-AZ_DrivingLicense_1996", "US-AZ_DrivingLicense_1990", "US-MS_DrivingLicense_2017", "US-MS", "US-MS_DL", "US-MS_DrivingLicense_2001", "US-AL_DrivingLicense_2013", "US-AL", "US-AL_DL", "US-AL_IDCard_2013", "US-AL_ID", "US_ID", "US-KS_DrivingLicense_2017", "US-KS", "US-KS_DL", "US-KS_DrivingLicense_2004", "US-OK_DrivingLicense_2018", "US-OK", "US-OK_DL", "US-TX_DrivingLicense_2016", "US-TX", "US-TX_DL", "US-TX_IDCard_2016", "US-TX_ID", "US-NM_DrivingLicense_2016", "US-NM", "US-NM_DL", "US-NM_DrivingLicense_2014", "US-CA_DrivingLicense_2018", "US-CA", "US-CA_DL", "US-NV_DrivingLicense_2014", "US-NV", "US-NV_DL", "US-FL_DrivingLicense_2017", "US-FL", "US-FL_DL", "US-CT_DrivingLicense_2017", "US-CT", "US-CT_DL", "XX_XX_XXXX", "ES_IDCard_2015", "ES2_ID", "ES_IDCard_2006", "ES_ResidencePermit_2010", "ES_ResidencePermit_2011", "ES_ResidencePermit_2020", "MX_IDCard_2013", "MX_IDCard_2014", "MX2", "MX2_ID", "MX_IDCard_2008", "MX_IDCard_2019", "MX_ResidencePermit_2010", "AR_IDCard_2009", "AR2", "AR2_ID", "AR_IDCard_2012", "US-HI_DrivingLicense_2012", "US-HI", "US-HI_DL", "US-HI_DrivingLicense_2018", "US-ME_DrivingLicense_2011", "US-ME", "US-ME_DL", "US-IL_DrivingLicense_2016", "US-IL", "US-IL_DL", "US-IL_DrivingLicense_2007", "US-ID_DrivingLicense_2010", "US-ID", "US-ID_DL", "US-ID_DrivingLicense_2017", "US-ID_DrivingLicense_2004", "US-MD_DrivingLicense_2016", "US-MD", "US-MD_DL", "US-MD_DrivingLicense_2013", "US-MI_DrivingLicense_2017", "US-MI", "US-MI_DL", "US-TN_DrivingLicense_2012", "US-TN", "US-TN_DL", "US-TN_DrivingLicense_2003", "US-DC_DrivingLicense_2017", "US-DC", "US-DC_DL", "US-MA_DrivingLicense_2018", "US-MA", "US-MA_DL", "US-MA_DrivingLicense_2010", "US-AK_DrivingLicense_2014", "US-AK", "US-AK_DL", "US-AK_DrivingLicense_2018", "US-AK_DrivingLicense_2005", "US-IN_DrivingLicense_2010", "US-IN", "US-IN_DL", "US-IN_DrivingLicense_2017", "US-NE_DrivingLicense_2013", "US-NE", "US-NE_DL", "US-NH_DrivingLicense_2017", "US-NH", "US-NH_DL", "US-NH_DrivingLicense_2006", "US-NY_DrivingLicense_2017", "US-NY", "US-NY_DL", "US-NY_DrivingLicense_2008", "US-OH_DrivingLicense_2018", "US-OH", "US-OH_DL", "US-OH_DrivingLicense_2014", "US-OH_DrivingLicense_2013", "US-WV_DrivingLicense_2013", "US-WV", "US-WV_DL", "US-WV_DrivingLicense_2005", "US-UT_DrivingLicense_2016", "US-UT", "US-UT_DL", "US-UT_DrivingLicense_2006", "US-RI_DrivingLicense_2018", "US-RI", "US-RI_DL", "US-SD_DrivingLicense_2010", "US-SD", "US-SD_DL", "US-WI_DrivingLicense_2015", "US-WI", "US-WI_DL", "US-WI_DrivingLicense_2005", "US-PA_DrivingLicense_2017", "US-PA", "US-PA_DL", "US-PA_DrivingLicense_2011", "US-VT_DrivingLicense_2014", "US-VT", "US-VT_DL", "US-VT_DrivingLicense_2018", "US-VA_DrivingLicense_2018", "US-VA", "US-VA_DL", "US-VA_IDCard_2018", "US-VA_ID", "US-WY_DrivingLicense_2014", "US-WY", "US-WY_DL", "US-WA_DrivingLicense_2017", "US-WA", "US-WA_DL", "US-WA_DrivingLicense_2019", "US-WA_DrivingLicense_2010", "US-MO_DrivingLicense_2012", "US-MO", "US-MO_DL", "US-MO_DrivingLicense_2004", "US-MT_DrivingLicense_2000", "US-MT", "US-MT_DL", "US-MT_DrivingLicense_2008", "GT_IDCard_2009", "GT", "GT_ID", "AU-WA_DrivingLicense_2014", "AU", "AU-WA", "AU-WA_DL", "AU_DL", "AU-TAS_DrivingLicense_2015", "AU-TAS", "AU-TAS_DL", "AU-QLD_DrivingLicense_2016", "AU-QLD", "AU-QLD_DL", "AU-QLD_DrivingLicense_2011", "AU-NT_DrivingLicense_2006", "AU-NT", "AU-NT_DL", "AU-NSW_DrivingLicense_2013", "AU-NSW", "AU-NSW_DL", "AU-SA_DrivingLicense_2014", "AU-SA", "AU-SA_DL", "AU-VIC_DrivingLicense_2009", "AU-VIC", "AU-VIC_DL", "AU-ACT_DrivingLicense_2011", "AU-ACT", "AU-ACT_DL", "AU-WA_DrivingLicense_2011", "CA-AB_DrivingLicense_2009", "CA", "CA-AB", "CA-AB_DL", "CA_DL", "CA-AB_IDCard_2018", "CA-AB_ID", "CA_ID", "CA-QC_DrivingLicense_2015", "CA-QC", "CA-QC_DL", "CA-SK_DrivingLicense_2016", "CA-SK", "CA-SK_DL", "CA-SK_IDCard_2014", "CA-SK_ID", "CA-YT_DrivingLicense_2010", "CA-YT", "CA-YT_DL", "CA-PE_DrivingLicense_2017", "CA-PE", "CA-PE_DL", "CA-ON_DrivingLicense_2007", "CA-ON", "CA-ON_DL", "CA-ON_IDCard_2011", "CA-ON_ID", "CA-NU_DrivingLicense_2009", "CA-NU", "CA-NU_DL", "CA-MB_DrivingLicense_2014", "CA-MB", "CA-MB_DL", "CA-NS_DrivingLicense_2017", "CA-NS", "CA-NS_DL", "CA-NB_DrivingLicense_2017", "CA-NB", "CA-NB_DL", "UY_IDCard_1999", "UY", "UY_ID", "UY_IDCard_2015", "TR_IDCard_2016", "TR", "TR_ID", "RU_DrivingLicense_2011", "RU", "RU_DL", "US-CT_DrivingLicense_2009", "US-KS_DrivingLicense_2012", "US-DE_DrivingLicense_2010", "US-DE", "US-DE_DL", "US-IA_DrivingLicense_2013", "US-IA", "US-IA_DL", "US-IA_DrivingLicense_2018", "US-FL_DrivingLicense_2010", "US-CA_DrivingLicense_2008", "US-RI_DrivingLicense_2008", "US-WI_DrivingLicense_2012", "US-MN_DrivingLicense_2004", "US-MN", "US-MN_DL", "US-MN_DrivingLicense_2018", "PL_IDCard_2019", "NZ_DrivingLicense_2007", "NZ", "NZ_DL", "SE_DrivingLicense_2013", "PT_DrivingLicense_1999", "CA-NT_DrivingLicense_2005", "CA-NT", "CA-NT_DL", "CA-NB_IDCard_2020", "CA-NB_ID", "CA-NL_DrivingLicense_2017", "CA-NL", "CA-NL_DL", "CA-BC_DrivingLicense_2013", "CA-BC", "CA-BC_DL", "CA-BC_IDCard_2009", "CA-BC_ID", "CA-BC_IDCard_2013", "CN_IDCard_2004", "CN", "CN_ID", "BR_DrivingLicense_2017", "BR", "BR_DL", "BR_DrivingLicense_2019", "BR_IDCard_2014", "BR_ID", "US-DE_DrivingLicense_2018", "US-KY_DrivingLicense_2019", "US-KY", "US-KY_DL", "US-KY_DrivingLicense_2012", "US-NJ_DrivingLicense_2011", "US-NJ", "US-NJ_DL", "US-OR_DrivingLicense_2018", "US-OR", "US-OR_DL", "US-OR_DrivingLicense_2007", "US-ND_DrivingLicense_2018", "US-ND", "US-ND_DL", "US-ND_DrivingLicense_2006", "PA_IDCard_2010", "PA", "PA_ID", "MY_IDCard_2012", "DO_IDCard_1998", "DO", "DO_ID", "DO_IDCard_2014", "US_IDCard-MilitaryRS_1993", "US-AK_ID", "US-AR_ID", "US-AZ_ID", "US-CA_ID", "US-CO_ID", "US-CT_ID", "US-DC_ID", "US-DE_ID", "US-FL_ID", "US-GA_ID", "US-HI_ID", "US-IA_ID", "US-ID_ID", "US-IL_ID", "US-IN_ID", "US-KS_ID", "US-KY_ID", "US-LA_ID", "US-MA_ID", "US-MD_ID", "US-ME_ID", "US-MI_ID", "US-MN_ID", "US-MO_ID", "US-MS_ID", "US-MT_ID", "US-NC_ID", "US-ND_ID", "US-NE_ID", "US-NH_ID", "US-NJ_ID", "US-NM_ID", "US-NV_ID", "US-NY_ID", "US-OH_ID", "US-OK_ID", "US-OR_ID", "US-PA_ID", "US-RI_ID", "US-SC_ID", "US-SD_ID", "US-TN_ID", "US-UT_ID", "US-VT_ID", "US-WA_ID", "US-WI_ID", "US-WV_ID", "US-WY_ID", "US_IDCard-MilitaryRT_1993", "US_IDCard-MilitaryRR_1993", "PH_DrivingLicense_2017", "PH", "PH_DL", "PH_IDCard_2011", "PH_ID", "PH_IDCard_2015", "PH_IDCard_2016", "PH_IDCard-PO_2016", "SG_IDCard_2011", "SG", "SG_ID", "IT_HealthCard_2004", "IT_HC", "XX_HC", "CO_IDCard_2020", "US_ResidencePermit_2017", "NO_IDCard_2020", "NO_ID", "ES_IDCard_2021", "ES_ResidencePermit_2007", "AT_ResidencePermit_2020", "RU_IDCard_2007", "RU_ID", "AT_IDCard_2021", "GB_DrivingLicense_2021", "DE_IDCard_2021", "FI_IDCard_2021", "CY_IDCard_2021", "PT_ResidencePermit_2017", "PT_ResidencePermit_2019", "CA-MB_IDCard_2009", "CA-MB_ID", "MX_ProfessionalCard_2008", "MX2_PC", "XX_PC", "AD_ResidencePermit_2018", "AD_ID", "FR_DrivingLicense_2006", "EC_IDCard_2009", "EC", "EC_ID", "AM_IDCard_2012", "AM", "AM_ID", "ZA_DrivingLicense_2004", "ZA", "ZA_DL", "ZA_IDCard_2013", "ZA_ID", "GB_DrivingLicense_2022", "GB_DrivingLicense_2012", "PT_ResidencePermit_2020", "IT_HealthCard_2022", "GB_ResidencePermit_2015", "GB_ID", "GB_ResidencePermit_2021", "HR_IDCard_2021", "PT_DrivingLicense_2021", "XX_MRZType1_YYYY", "PE_ResidencePermit_2021", "CA-AB_DrivingLicense_2018", "IT_IDCard_2022" ] } }, "additionalProperties": false }, "views": { "type": "object", "properties": { "instructions": { "type": "object", "properties": { "active": { "description": "If true, displays a instructions component to inform the user.", "type": "boolean", "default": true, "$id": "videoInstructionsActive" }, "header": { "type": "object", "properties": { "title": { "description": "Title of the instructions component.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Antes de comenzar el proceso, lea estas sencillas instrucciones" ], "EN": [ "Before starting the process, read these simple instructions" ] }, "$id": "videoInstructionsMainHeader" } }, "additionalProperties": false }, "card": { "type": "object", "properties": { "title": { "type": "object", "properties": { "video": { "description": "List of titles in document flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "Centre su cara y diga su nombre y apellidos", "Muestre su documento a cámara por ambos lados" ], "EN": [ "Center your face and say your first and last name", "Show your document to the camera on both sides" ] }, "$id": "videoInstructionsTitle" } }, "additionalProperties": false }, "subtitle": { "type": "object", "properties": { "video": { "description": "List of subtitles in document flow for the instructions slides.", "vdTypes": "translatable", "type": "array", "default": { "ES": [ "1. Centre su cara en el óvalo y no sonría. \n 2. Diga su nombre y apellidos en voz alta cuando se indique en pantalla", "Muestre el documento a cámara, primero la parte delantera y luego la parte trasera, como se indica en pantalla" ], "EN": [ "1. Center your face within the oval and do not smile. \n 2. Say your first and last name out loud when prompted on screen", "Show the document to the camera, first the front and then the back, as indicated on the screen" ] }, "$id": "videoInstructionSubTitle" } }, "additionalProperties": false }, "media": { "type": "object", "properties": { "video": { "description": "List of media in document flow for the instructions slides.", "vdTypes": "fetchable", "type": "array", "legacyPathMedia": [ "/images/video.jpg", "/images/video1.jpg" ], "default": [ "/images/video.jpg", "/images/video1.jpg" ], "$id": "videoInstructionsMedia" } }, "additionalProperties": false }, "header": { "description": "Header to Instructions.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Instrucciones", "EN": "Instructions" }, "$id": "videoInstructionsHeader" }, "buttons": { "type": "object", "properties": { "next": { "type": "object", "properties": { "media": { "description": "Media for next button in the instructions component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrow-right.svg", "default": "/images/arrow-right.svg", "$id": "videoInstructionsButtonNextMedia" }, "text": { "description": "Text for next button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Siguiente", "EN": "Next" }, "$id": "videoInstructionsButtonNextText" } }, "additionalProperties": false }, "previous": { "type": "object", "properties": { "media": { "description": "Media for previous button in the instructions component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/arrow-left.svg", "default": "/images/arrow-left.svg", "$id": "videoInstructionsButtonPrevMedia" }, "text": { "description": "Text for previous button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Anterior", "EN": "Previous" }, "$id": "videoInstructionsButtonPrevText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "progressIndicator": { "type": "object", "properties": { "show": { "description": "If true, displays the progress indicator component.", "type": "boolean", "default": true, "$id": "videoInstructionsProgressIndicator" } }, "additionalProperties": false }, "buttons": { "type": "object", "properties": { "startProcess": { "type": "object", "properties": { "text": { "description": "Text for continue button in the instructions component.", "vdTypes": "translatable", "type": "string", "default": { "EN": "Start", "ES": "Comenzar" }, "$id": "videoInstructionsButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "capture": { "type": "object", "properties": { "positionGuides": { "description": "Guides used to indicate the end user that the document has been detected in the 'x' and 'y' position.", "type": "object", "properties": { "colors": { "description": "Colors from each guide. You can configure it in two ways: By declaring just one color and every guide will be from that color or by specifying each guide color based on the number of guides 'num' specified. IE. If 'num' is 3, you have to configure exactly 3 colors.", "type": "array", "items": { "type": "string", "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$" }, "default": [ "#000D44", "#000D44", "#000D44", "#000D44", "#000D44" ], "$id": "videoDocumentPositionGuides" }, "num": { "description": "Number of guides to be shown on each corner once the document has been detected. The Maximum number of guides is 5.", "type": "number", "minimum": 1, "maximum": 5, "default": 5, "$id": "videoDocumentPositionGuidesNum" } }, "additionalProperties": false }, "guidance": { "type": "object", "properties": { "preCapture": { "type": "object", "properties": { "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display pre capture message.", "type": "string", "default": "Capture", "$id": "videoDocumentPreCaptureObverseHeader" }, "title": { "description": "Title of the capture component that shows the steps to take a photo of the document.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Muestre la parte DELANTERA del documento en la CÁMARA FRONTAL", "EN": "Show the FRONT of the document to the FRONT CAMERA" }, "$id": "videoDocumentPreCaptureObverseTitle" }, "media": { "description": "Media for the capture component that shows the steps to take a photo of the document.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "videoDocumentPreCaptureObverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display pre capture message.", "type": "string", "default": "Capture", "$id": "videoDocumentPreCaptureReverseHeader" }, "title": { "description": "Title of the capture component that shows the steps to take a photo of the document.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Muestre la parte TRASERA del documento en la CÁMARA FRONTAL", "EN": "Show the BACK of the document to the FRONT CAMERA" }, "$id": "videoDocumentPreCaptureReverseTitle" }, "media": { "description": "Media for the capture component that shows the steps to take a photo of the document.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "videoDocumentPreCaptureReverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "selfie": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the capture component shown in the selfie flow.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Centre la cara en el óvalo", "EN": "Fit your face into the oval" }, "$id": "videoPreCaptureSelfieTitle" }, "media": { "description": "Media image in the selfie capture description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoPreCaptureSelfieMedia" }, "header": { "description": "Header to display selfie Flow.", "type": "string", "vdTypes": "translatable", "default": { "ES": "Siga las instrucciones", "EN": "Follow the instructions" }, "$id": "videoPreCaptureSelfieHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display capture message.", "type": "string", "default": "Capture", "$id": "videoDocumentCaptureObverseHeader" }, "title": { "description": "Title indicating how to capture a photo.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Capturando ...", "EN": "Capturing ..." }, "$id": "videoDocumentCaptureObverseTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "videoDocumentCaptureObverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display capture message.", "type": "string", "default": "Capture", "$id": "videoDocumentCaptureReverseHeader" }, "title": { "description": "Title indicating how to capture a photo.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Capturando ...", "EN": "Capturing ..." }, "$id": "videoDocumentCaptureReverseTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "videoDocumentCaptureReverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "selfie": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the capture component shown in the selfie flow.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Centre la cara en el óvalo", "EN": "Fit your face into the oval" }, "$id": "videoCaptureSelfieTitle" }, "media": { "description": "Media image in the selfie capture description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoCaptureSelfieMedia" }, "header": { "description": "Header to display selfie Flow.", "type": "string", "vdTypes": "translatable", "default": { "ES": "Siga las instrucciones", "EN": "Follow the instructions" }, "$id": "videoCaptureSelfieHeader" } }, "additionalProperties": false }, "centered": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the user's face is centered.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Manténgase estable y no sonría", "EN": "Stay still and do not smile" }, "$id": "videoFaceCenteredTitle" }, "media": { "description": "Media image in the face-centered description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoFaceCenteredMedia" }, "header": { "description": "Header to display selfie Flow.", "type": "string", "vdTypes": "translatable", "default": { "ES": "Siga las instrucciones", "EN": "Follow the instructions" }, "$id": "videoFaceCenteredHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "notCentered": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the user's face is not centered.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Vuelva a centrar la cara en el óvalo", "EN": "Recenter your face within the oval" }, "$id": "videoFaceNotCenteredTitle" }, "media": { "description": "Media for the error component that shows when the user's face is not centered.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoFaceNotCenteredMedia" }, "header": { "description": "Header to display a text message error when face is not centered.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "videoFaceNotCenteredHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "nameAndSurname": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the nameAndSurname component that shows when we ask the user's name and surname.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Diga su nombre y apellidos en voz alta", "EN": "Say your first and last name out loud" }, "$id": "videoNameAndSurnameTitle" } }, "additionalProperties": false } }, "additionalProperties": false }, "documentNotFound": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display document not found message.", "type": "string", "default": "Instructions", "$id": "videoDocumentNotFoundHeader" }, "title": { "description": "Title indicating how to capture a photo manually.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No se ha podido detectar el documento. Por favor, colóquelo en el recuadro", "EN": "The document could not be detected. Please, place it within the box" }, "$id": "videoDocumentNotFoundTitle" }, "media": { "description": "Media for the capture component that indicating how to capture a photo manually.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "videoDocumentNotFoundMedia" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "tooFar": { "type": "object", "properties": { "obverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display too far message.", "type": "string", "default": "Capture", "$id": "videoDocumentTooFarObverseHeader" }, "title": { "description": "Title indicating that the document is too far away.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Acerque el documento", "EN": "Zoom in the document" }, "$id": "videoDocumentTooFarObverseTitle" }, "media": { "description": "Media for the card component that the document is too far away.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoDocumentTooFarObverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false }, "reverse": { "type": "object", "properties": { "card": { "type": "object", "properties": { "header": { "description": "Header to display too far message.", "type": "string", "default": "Capture", "$id": "videoDocumentTooFarReverseHeader" }, "title": { "description": "Title indicating that the document is too far away.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Acerque el documento", "EN": "Zoom in the document" }, "$id": "videoDocumentTooFarReverseTitle" }, "media": { "description": "Media for the card component that the document is too far away.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoDocumentTooFarReverseMedia" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "flipFrameAnimation": { "type": "object", "properties": { "active": { "description": "If true it will make an animation.", "type": "boolean", "default": true, "$id": "videoDocumentFlipFrameAnimation" } }, "additionalProperties": false }, "selectCamera": { "description": "Selects by default the best front to capture and detect with the SDK.", "type": "string", "enum": ["front"], "default": "front", "$id": "videoSelectCamera" }, "constraints": { "description": "Camera constraints input to customize the values.", "type": "object", "properties": { "video": { "description": "Video property main constraint.", "type": "object", "properties": { "height": { "description": "Video height property main constraint.", "type": "number", "enum": [1080], "default": 1080, "$id": "videoHeightVideo" } }, "additionalProperties": false }, "audio": { "description": "If true, the microphone will be enabled.", "type": "boolean", "enum": [true], "default": true, "$id": "audioVideo" } }, "additionalProperties": false }, "successTick": { "description": "Component that displays a success check once the capture has been successfully done.", "type": "object", "properties": { "show": { "description": "If true, displays the a success tick component when the capture process has been success.", "type": "boolean", "default": true, "$id": "videoSuccessTickShow" }, "media": { "description": "Custom media file to be shown when success tick component is displayed. `IMPORTANT: if empty it will use default tick`", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "", "default": "", "$id": "videoSuccessTickMedia" } }, "additionalProperties": false }, "detectionTimeout": { "description": "Duration in milliseconds after which the SDK should stop recording and shut down. Max is 300000, min 60000.", "type": "number", "minimum": 60000, "maximum": 300000, "default": 300000, "$id": "videoDetectionTimeout" }, "alternativeVideoRecorder": { "description": "If true, the alternative video recorder will be used in all devices.", "type": "boolean", "default": false, "$id": "videoAlternativeVideoRecorder" } }, "additionalProperties": false }, "feedback": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "orientationChangedRestartMessage": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Title for the error component that shows when the process is stopped by an orientation change.", "vdTypes": "translatable", "type": "string", "default": { "ES": "No se ha podido completar el proceso debido a un cambio de orientación inesperado del dispositivo", "EN": "The process could not be completed due to an unexpected change in the device's orientation" }, "$id": "videoOrientationChangedRestartMessageTitle" }, "media": { "description": "Media for the message in the error component that shows when the process is stopped by an orientation change.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoOrientationChangedRestartMessageMedia" }, "header": { "description": "Header to display Error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "videoOrientationChangedRestartMessageHeader" }, "buttons": { "type": "object", "properties": { "restart": { "type": "object", "properties": { "text": { "description": "Text for the button in the error component that shows when the process is stopped by an orientation change.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Reiniciar", "EN": "Try again" }, "$id": "videoOrientationChangedRestartMessageButtonText" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorNotFound": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to user if media device is not found.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Por favor, compruebe que su dispositivo dispone de cámara", "EN": "Please check that your device has a camera" }, "$id": "videoVideoErrorNotFoundTitle" }, "media": { "description": "Media image in the videoErrorNotFound description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoVideoErrorNotFoundMedia" }, "header": { "description": "Header to display to user if media device is not found.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "videoVideoErrorNotFoundHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorPermission": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to the user if camera device media or microphone does not have permission.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Por favor, asegúrese de permitir a la página acceso a la cámara y micrófono", "EN": "Please, make sure to allow the page access to the camera and microphone" }, "$id": "videoVideoErrorPermissionTitle" }, "media": { "description": "Media image in the videoErrorPermission description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoVideoErrorPermissionMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "videoVideoErrorPermissionHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "videoErrorDefault": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to user if there is a media default error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Lo sentimos, se ha producido un error al iniciar la cámara", "EN": "Sorry, there has been an error when initiating the camera" }, "$id": "videoVideoErrorDefaultTitle" }, "media": { "description": "Media image in the videoErrorDefault description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoVideoErrorDefaultMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "videoVideoErrorDefaultHeader" } }, "additionalProperties": false } }, "additionalProperties": false }, "dependenciesErrorText": { "type": "object", "properties": { "card": { "type": "object", "properties": { "title": { "description": "Error to display to the user if there is a dependency error.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Lo sentimos, se ha producido un error cargando las dependencias. Revise su configuración y compruebe la ruta de sus recursos", "EN": "Sorry, there has been an error when loading dependencies. Please, review your configuration and check the path of your resources" }, "$id": "videoDependenciesErrorTextTitle" }, "media": { "description": "Media image in the dependenciesErrorText description message.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/danger.svg", "default": "/images/danger.svg", "$id": "videoDependenciesErrorTextMedia" }, "header": { "description": "Header to display an error message.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Error", "EN": "Error" }, "$id": "videoDependenciesErrorTextHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "deviceRotated": { "type": "object", "properties": { "active": { "description": "If true, displays a device rotated component to inform the user.", "type": "boolean", "default": false, "$id": "videoDeviceRotatedActive" }, "onOrientation": { "description": "Modifies the orientation in which the device rotated component appears.", "type": "string", "enum": ["landscape", "portrait"], "default": "landscape", "$id": "videoOrientationMode" }, "card": { "type": "object", "properties": { "title": { "description": "Title for the device rotated component.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Para continuar, coloque el teléfono en orientación VERTICAL", "EN": "To continue, put the phone in VERTICAL orientation" }, "$id": "videoDeviceRotatedTitle" }, "media": { "description": "Media for the device rotated component.", "vdTypes": "fetchable", "type": "string", "legacyPathMedia": "/images/gifs/rotateMedia.gif", "default": "/images/rotateMedia.gif", "$id": "videoDeviceRotatedMedia" }, "header": { "description": "Header to display Rotate device.", "vdTypes": "translatable", "type": "string", "default": { "ES": "Aviso", "EN": "Disclaimer" }, "$id": "videoDeviceRotatedHeader" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "pathAssets": { "description": "Location folder for all the assets given in the release package.", "type": "string", "default": "assets", "$id": "videoPathAssets" } }, "additionalProperties": false }, "additionalProperties": false } }