Options¶

This property is used to customize the UI and behavior settings for each stage.

Property	Type	Required
qr	object	Yes, if it is declared in the 'stages' property
document	object	No
selfie	object	No
video	object	No
esign	object	Yes, if it is declared in the 'stages' property
pepSanctions	object	Yes, if it is declared in the 'stages' property
identityVerification	object	Yes, if it is declared in the 'stages' property
timestamp	object	Yes, if it is declared in the 'stages' property

QR¶

This section consists of displaying a QR to redirect end users to mobile. This functionality only applies to desktop devices.

The process is that the end user captures the QR from the mobile and is redirected to that URL. In this way the end user can continue the process from the mobile with a more optimal capture.

In order to continue the process from the mobile it is necessary for the integrator to apply its management logic to load the same onboarding process previously requested on desktop.

For a detailed explanation of a QR setup use case, please refer How to redirect onboardings from desktop to mobile using QR redirection.

Property	Type	Required
redirectionUrl	string	Yes
setup	object	No

Setup¶

Property	Description	Type	Required	Default Value	Possible Values
buttons.continue.show	This is used to hide the "Continue" button in the browser, forcing the user to complete the process on their mobile device after scanning the QR code.	boolean	No	true	true or false
modal.show	This prevents the information modal from being displayed during the QR capture process.	boolean	No	true	true or false

Document¶

This property is used to customize the UI and behavior settings for the document stage.

Property	Type	Required	Default Value	Possible Values
extendedCoverage	boolean	No	false	true or false
captures	array	No	-	-

Captures¶

In this section, you can configure more than one document capture by specifying the following configuration within an array.

Property	Type	Required	Default Value	Possible Values
serviceMode	string	No	validation	"validation", "ocr"
documentTypes	array	Yes	["SelectedByUser"]	For a detailed list of all possible values, please check vali-Das documentation in section Document Type name specification.
excludedDocumentTypes	array	No	-	For a detailed list of all possible values, please check vali-Das documentation in section Document Type name specification.
additionalDocumentTypes	array	No	-	Same values as `excludedDocumentTypes`. Adds the document types of a country or region on top of `documentKindFilter`.
scoresConfiguration	object	No	-	-
documentSelector	object	No	-	-
nfc	object	No	-	-
setup	object	No	-	-

Adding and excluding document types per country or region¶

documentKindFilter gives every country of the selector the same document types. These two properties change that for one country or one region:

additionalDocumentTypes adds document types to a country or region.
excludedDocumentTypes removes document types from a country or region.

Both properties take the same codes, made up of a geographical area followed by the document type, for example MT_IDCard, CA_DrivingLicense or CA-ON_DrivingLicense.

Both properties shape the coverage offered by the document selector. excludedDocumentTypes is also applied when the captured document is analysed, so a document excluded there is rejected even if it is sent directly. additionalDocumentTypes only adds coverage that the service already supports, so it does not change the analysis of the capture.

The full explanation of the codes, how the two properties combine and several configuration examples are described in the Customer journey.

ScoresConfiguration¶

Property	Type	Required	Default Value	Possible Values
maximumAcceptableTimeSinceExpiration	number	No	-	1 to 36500
minimumAcceptableAge	number	No	-	0 to 100
modifiers	object	No	-	see Vali-Das documentation

Document & Country selector¶

In this section, you can configure the behavior and UI of the document selector before the document capture process. Here, you can specify the countries and types of documents that you want to represent in the selector.

Property	Type	Required	Default Value	Possible Values
countryFilter	array	No	all countries listed	Comma-separated list of any of possible ISO 3166-1 alfa-2 codes.
documentKindFilter	array	No	["IDCard","DrivingLicense","HealthCard", "ProfessionalCard","Passport","XX_XX_XXXX"]	Comma-separated list of possible ["IDCard","DrivingLicense" , "HealthCard" , "ProfessionalCard" , "Passport" , "XX_XX_XXXX" , "AnyCard"]. The `AnyCard` value can only be sent as ["AnyCard"] or ["AnyCard", "Passport"] or ["AnyCard", "Passport", "XX_XX_XXXXXX"], the combination with the other values is wrong. Note: The IDCard value includes the following types of document: IDCard, ResidencePermit, IDCard-PO, IDCard-MilitaryRS, IDCard-MilitaryRT, IDCard-MilitaryRR.
setup	object	No	-	-

Setup¶

In this section, you can configure the behavior of document selector

Property	Description	Type	Required	Default Value	Possible Values
geolocation		boolean	No	true	true or false
countryChooser.defaultCountry		string	No	ES	Supported format: ISO 3166-1 alpha-2
regionChooser.enabled	Shows the states/provinces of the countries covered at that level	boolean	No	false	true or false

Some countries issue their identity documents at state or province level, so the same document type is not available in all of them. With regionChooser.enabled set to true, the document selector shows a second selector with the states/provinces of the selected country, and the document types are only displayed once one of them is chosen. Only the countries covered at that level offer this second selector, currently the United States (US), Canada (CA) and Australia (AU); the rest of the countries keep working at country level.

{
  "documentSelector": {
    "countryFilter": ["US", "CA"],
    "setup": {
      "regionChooser": {
        "enabled": true
      }
    }
  }
}

NFC¶

In this section, you can configure the behavior and UI of the NFC document capture process.

Property	Type	Required	Default Value	Possible Values
enabled	boolean	Yes	false	true or false
setup (iOS/Android)	object	No	-	-

Setup¶

In this section, you can configure the behavior of the document capture process.

Property	Description	Type	Required	Default Value	Possible Values
detectionTimeout	Timeout for document detection	number	No	300000	60000 to 300000
deviceRotatedOnOrientation	Device rotation orientation	string	No	none	landscape, portrait or none
deviceRotatedShow	Show device rotation prompt	boolean	No	true	true or false
instructionsShow	Show capture instructions	boolean	No	true	true or false
manualCaptureButtonDelay	Delay for manual capture button	number	No	20000	1500 to 300000
manualCaptureShow	Show manual capture button	boolean	No	true	true or false
reviewShow	Show review screen	boolean	No	true	true or false
selectCamera	Camera selection	string	No	back	front or back
uiOrientation	Force UI orientation	string	No	-	"portrait" or "landscape"

The uiOrientation property is only supported for native platforms (ios and android). Sending this property when platform is web will return a 400 error.

Selfie¶

This property is used to customize the UI and behavior settings for the selfie stage.

The selfie capture process can be performed in two modes: in passive mode, a selfie capture is taken, or in active mode, which requires a random head movement, specifying the number of movements through the "challengeLength" property.

Property	Type	Required	Default Value	Possible Values
liveness	string	No	"passive"	"passive" or "active"
challengeLength	number	Yes, if the "liveness" property has the value "active".	-	1 to 6
setup	object	No	-	-

Setup¶

Property	Description	Type	Required	Default Value	Possible Values
detectionTimeout	Time in ms before recording stops and SDK shuts down	number	No	300000	60000 to 300000
instructionsShow	Displays the instructions view if set to true	boolean	No	true	true or false
selectCamera	Chooses which camera to use in the flow	string	No	front	front or back
reviewShow	Displays the review view if set to true	boolean	No	false	true or false
uiOrientation	Force UI orientation	string	No	-	"portrait" or "landscape"

The reviewShow property is always false when the liveness property is set to active.

The uiOrientation property is only supported for native platforms (ios and android). Sending this property when platform is web will return a 400 error.

Video¶

This property is used to customize the UI and behavior settings for the video stage.

Property	Type	Required	Default Value	Possible Values
videoDocComparison	boolean	No	false	true or false
setup	object	No	-	-

Setup¶

Property	Description	Type	Required	Default Value	Possible Values
detectionTimeout	Time in ms before recording stops and SDK shuts down	number	No	300000	60000 to 300000
instructionsShow	Displays the instructions view if set to true	boolean	No	true	true or false
selectCamera	Chooses which camera to use in the flow	string	No	front	front or back
nameSurnameShow	Enables the stage of saying first and last names	boolean	No	true	true or false.
uiOrientation	Force UI orientation	string	No	-	"portrait" or "landscape"

The uiOrientation property is only supported for native platforms (ios and android). Sending this property when platform is web will return a 400 error.

Important Notice

When setting nameSurnameShow: false with default texts (no language specified in the JSON), you must customize the video instruction texts for all supported languages to avoid displaying "First and last names". Update the following properties:

- `texts.video.instructions.firstStep.title`
- `texts.video.instructions.firstStep.subtitle`

Esign¶

This property is used to customize the UI and behavior settings for the esign stage.

Property	Type	Required
title	string	Yes
signers	array of items	Yes
libraryDocumentIds	array of strings	Yes
setup	object	No

Signers¶

Property	Type	Required
name	string	Yes
email	string	Yes

Setup¶

Property	Description	Type	Required	Default Value	Possible Values
requireTermsAndConditions	When set to true, the signing flow explicitly asks the user to accept the Terms & Conditions. When set to false, the user is not prompted, assuming consent has already been obtained before starting the process.	boolean	No	true	true or false

Politically Exposed Persons (PEP) & Adverse Media setup¶

Here is an explanation of what PEP and Adverse Media is. The types refer to the kinds of alert or warning associated with the entity.

Property	Type	Required	Default Value	Possible Values
types	array	Yes	-	[ "pep", "pep-class-1", "pep-class-2", "pep-class-3", "pep-class-4", "sanction", "warning", "adverse-media-v2-property", "adverse-media-v2-financial-aml-cft", "adverse-media-v2-fraud-linked", "adverse-media-v2-narcotics-aml-cft", "adverse-media-v2-violence-aml-cft", "adverse-media-v2-terrorism", "adverse-media-v2-cybercrime", "adverse-media-v2-general-aml-cft", "adverse-media-v2-regulatory", "adverse-media-v2-financial-difficulty", "adverse-media-v2-violence-non-aml-cft", "adverse-media-v2-other-financial", "adverse-media-v2-other-serious", "adverse-media-v2-other-minor"]

IdentityVerification¶

Validate a document with a third party identity verification service Spanish Data Verification and Consultation Service, AAMVA, RENIEC, ReceitaFederal, RegistroCivil, INE-Check, RENAPO and INE-Check-RENAPO-Fallback

Property	Type	Required	Default Value	Possible Values
services	array	Yes	-	"AAMVA", "RENIEC", "ReceitaFederal", "ESMinistry", "RegistroCivil", "INE-Check", "RENAPO" or "INE-Check-RENAPO-Fallback"
applicationCode	string	Yes, If the "services" property has the value "ESMinistry"	-	-

Timestamp¶

This section is used to timestamp the evidence.

Property	Type	Required	Default Value	Possible Values
required	boolean	Yes	-	-
authority	string	Yes	-	"fnmt" or "standard" or "izenpe"

If the required property is set true, the operation is mandatory; if it fails twice in Validas, XpressID will report an error to the integrator and halt. Conversely, if set to false, any failure after two attempts is ignored, allowing XpressID to finalize the process without interruption.