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.
By default, the QR is not displayed on the desktop, to activate the QR process you have to set the parameter mobileQrRedirect.
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 (web) | object | No |
Document¶
This property is used to customize the UI and behavior settings for the document stage.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| contextualData | object | No | - | - |
| 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. |
| scoresConfiguration | object | No | - | - |
| documentSelector | object | No | - | - |
| autoclassificationSelector | object | No | - | - |
| nfc | object | No | - | - |
| setup (web/iOS/Android) | array | No | - | - |
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 (web/iOS/android) | object | No | - | - |
Autoclassification selector¶
In this section, you can configure the UI of the auto-classification selector.
| Property | Type | Required |
|---|---|---|
| setup (web) | object | No |
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 | - | - |
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 |
| contextualData | object | No | - | - |
| setup (web/iOS/Android) | object | No | - | - |
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 |
| contextualData | object | No | - | - |
| setup (web/iOS/Android) | object | No | - | - |
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 |
| contextualData | object | No |
| setup (web) | object | No |
Signers¶
| Property | Type | Required |
|---|---|---|
| name | string | Yes |
| string | Yes |
Politically Exposed Persons (PEP) & Adverse Media setup¶
Here is an explanation of what PEP and Adverse Media is.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| fuzziness | number | Yes | - | 0.0 to 1.0 |
| 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 and AAMVA
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| services | array | Yes | - | "AAMVA" or "ESMinistry" |
| 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" |