Operation modes¶
IDV¶
This section contains parameters that apply to the identity verification configuration. The IDV operation mode can be configured with a set of modules known as "stages", the default language for display, and the platform for which it will be used.
Below is the starting configuration scheme for the IDV operation mode.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| operationMode | string | Yes | - | "idv" |
| platform | string | Yes | - | "web", "android", "ios" |
| language | string | No | Detected by system/browser | The possible values can be consulted here |
| flowSetup | object | Yes | - | - |
| setup | object | No | - | - |
| texts | object or file* | No | - | - |
| medias | object or file* | No | - | - |
| styles | object or file* | No | - | - |
*Note: The texts, medias, and styles properties in the configuration JSON can also be provided as attached files using the same keys within a multipart/form-data request, following the appropriate Content-Type format.
Each property (texts, medias, and styles) must be provided in only one form: either directly within the JSON object or as a separate file attachment—not both.
Flow setup¶
This section provides the flexibility to determine the stages that are required for the onboarding process, as well as customize the user interface (UI) and behavior settings for each stage. This allows for a tailored and personalized experience that aligns with the specific needs of the application or organization.
| Property | Type | Required |
|---|---|---|
| stages | array | Yes |
| core | object | Yes |
| options | object | No |
Stages¶
The set of stages to execute within a flow, where the execution order is driven by XpressID, is referred to as a XpressID flow. It represents a predefined sequence of stages that are sequentially executed during the onboarding process. This structured approach ensures a consistent and streamlined experience for users, while also facilitating efficient data collection and verification.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| stages | array | Yes | - | "document","selfie","video","esign","pepSanctions","identityVerification","qr","timestamp" |
Core¶
This property is used to indicate actions specific to the 'idv' operation mode, for example, whether to confirm onboarding or not, along with its contextual data.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| confirmProcess | boolean | Yes | - | true or false |
| contextualData | object | No | - | - |
| pauseAfterStage | array | No | - | "document", "selfie", "video" |
Sending contextual data is recommended because it allows our customers to enhance their analytics, better understand user behavior and gain valuable insights into the performance of their validation workflows. You can find more information about contextual data here
Setup¶
This section provides the flexibility to customize the common views used throughout the onboarding process.
| Property | Type | Required | Default value | Possible Values |
|---|---|---|---|---|
| logo.show | boolean | No | true | true or false |
| success.show | boolean | No | true | true or false |
| errorModal.show | boolean | No | true | true or false |
| closeButton.show | boolean | No | true | true or false |
| helpModal.show | boolean | No | true | true or false |
| captureHeading.show | boolean | No | true | true or false |
| instructionsHeading.show | boolean | No | true | true or false |
| reviewHeading.show | boolean | No | true | true or false |
| cancelButtonInstructions.show | boolean | No | true | true or false |
AUTHENTICATION¶
This section contains parameters that apply to the authentication configuration. The AUTHENTICATION operation mode can be configured with a set of modules known as "stages", the default language for display, and the platform for which it will be used.
Below is the starting configuration scheme for the AUTHENTICATION operation mode.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| operationMode | string | Yes | - | "authentication" |
| platform | string | Yes | - | "web", "ios", "android" |
| language | string | No | Detected by system/browser | The possible values can be consulted here |
| flowSetup | object | Yes | - | - |
| setup | object | No | - | - |
| texts | object of file* | No | - | - |
| medias | object of file* | No | - | - |
| styles | object of file* | No | - | - |
*Note: The texts, medias, and styles properties in the configuration JSON can also be provided as attached files using the same keys within a multipart/form-data request, following the appropriate Content-Type format.
Each property (texts, medias, and styles) must be provided in only one form: either directly within the JSON object or as a separate file attachment—not both.
Flow setup¶
This section provides the flexibility to determine the stages that are required for the authentication process, as well as customize the user interface (UI) and behavior settings for each stage. This allows for a tailored and personalized experience that aligns with the specific needs of the application or organization.
| Property | Type | Required |
|---|---|---|
| stages | array | Yes |
| core | object | Yes |
| options | object | No |
Stages¶
The set of stages to execute within a flow, where the execution order is driven by XpressID, is referred to as a XpressID flow. It represents a predefined sequence of stages that are sequentially executed during the authentication process. This structured approach ensures a consistent and streamlined experience for users, while also facilitating efficient data collection and verification.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| stages | array | Yes | - | "selfie","qr" |
Core¶
This property is used to indicate actions specific to the 'authentication' operation mode, for example, the selfie image by which the identity is to be verified, along with its contextual data.
| Property | Type | Required |
|---|---|---|
| selfieImage | string (BASE64 image) or file* | Yes* |
| contextualData | object | No |
*Note: The selfieImage property is conditionally required based on the Content-Type of the request of token. This allows for the selfieImage to be provided either as a Base64 string or as a file, depending on the Content-Type specified in the request:
- When the Content-Type is application/json, selfieImage in BASE64 is required.
- When the Content-Type is multipart/form-data, selfieImage must be included as a file.
Setup¶
This section provides the flexibility to customize the common views used throughout the authentication process.
| Property | Type | Required | Default value | Possible Values |
|---|---|---|---|---|
| logo.show | boolean | No | true | true or false |
| success.show | boolean | No | true | true or false |
| errorModal.show | boolean | No | true | true or false |
| closeButton.show | boolean | No | true | true or false |
| helpModal.show | boolean | No | true | true or false |
| captureHeading.show | boolean | No | true | true or false |
| instructionsHeading.show | boolean | No | true | true or false |
| reviewHeading.show | boolean | No | true | true or false |
| cancelButtonInstructions.show | boolean | No | true | true or false |
AGE VERIFICATION¶
This section contains parameters that apply to the age verification configuration. The AGE VERIFICATION operation mode can be configured with a set of modules known as "stages", the default language for display, and the platform for which it will be used.
Below is the starting configuration scheme for the AGE VERIFICATION operation mode.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| operationMode | string | Yes | - | "ageVerification" |
| platform | string | Yes | - | "web" |
| language | string | No | Detected by system/browser | The possible values can be consulted here |
| flowSetup | object | Yes | - | - |
| setup | object | No | - | - |
| texts | object of file* | No | - | - |
| medias | object of file* | No | - | - |
| styles | object of file* | No | - | - |
*Note: The texts, medias, and styles properties in the configuration JSON can also be provided as attached files using the same keys within a multipart/form-data request, following the appropriate Content-Type format.
Each property (texts, medias, and styles) must be provided in only one form: either directly within the JSON object or as a separate file attachment—not both.
Flow setup¶
This section provides the flexibility to determine the stages that are required for the age verification process, as well as customize the user interface (UI) and behavior settings for each stage. This allows for a tailored and personalized experience that aligns with the specific needs of the application or organization.
| Property | Type | Required |
|---|---|---|
| stages | array | Yes |
| core | object | Yes |
| options | object | No |
Stages¶
The set of stages to execute within a flow, where the execution order is driven by XpressID, is referred to as a XpressID flow. It represents a predefined sequence of stages that are sequentially executed during the age verification process. This structured approach ensures a consistent and streamlined experience for users, while also facilitating efficient data collection and verification.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| stages | array | Yes | - | "selfie", "document", "qr" |
Core¶
This property is used to indicate actions specific to the 'ageVerification' operation mode, for example, the "ageTreshold" determines the minimum age requirement for users (between 18 and 21 years), along with its contextual data.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| ageThreshold | number | Yes | - | between 18 and 21 |
| contextualData | object | No | - |
Setup¶
This section provides the flexibility to customize the common views used throughout the age verification process.
| Property | Type | Required | Default value | Possible Values |
|---|---|---|---|---|
| logo.show | boolean | No | true | true or false |
| success.show | boolean | No | true | true or false |
| errorModal.show | boolean | No | true | true or false |
| closeButton.show | boolean | No | true | true or false |
| helpModal.show | boolean | No | true | true or false |
| captureHeading.show | boolean | No | true | true or false |
| instructionsHeading.show | boolean | No | true | true or false |
| reviewHeading.show | boolean | No | true | true or false |
| cancelButtonInstructions.show | boolean | No | true | true or false |
RESUME¶
The resume configuration section allows organizations to define specific parameters that influence the resumption of previously initiated "idv" processes. These parameters enable organizations to control how the onboarding process continues after an interruption, ensuring a seamless and efficient experience for users.
Below is the starting configuration scheme for the RESUME operation mode.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| operationMode | string | Yes | - | "resume" |
| platform | string | Yes | - | "web" |
| language | string | No | Detected by system/browser | The possible values can be consulted here |
| flowSetup | object | Yes | - | - |
Flow setup¶
In this section, you can specify the process you want to resume.
| Property | Type | Required |
|---|---|---|
| core | object | Yes |
Core¶
This property is used to indicate which process you want to resume.
| Property | Type | Required |
|---|---|---|
| validationId | string | Yes |