General¶
Operation mode¶
XpressID offers four operation modes:
idv for conducting onboarding processes through a sequence of capture and configuration steps.
authentication mode allows users to verify their identity through a facial recognition comparison.
ageVerification mode verifies users' ages between 18 and 21 using facial recognition with or without additional document checks.
resume for resuming previously initiated idv processes that were left incomplete or have expired.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| operationMode | string | Yes | - | "idv", "authentication", "ageVerification", "resume" |
Platform¶
The platform used to perform the process/flow depends on the specific integration requirements and the desired level of customization. XpressID can be integrated with various platforms, including:
- Web applications (web) :embedded directly into a web application using an iframe, allowing for seamless integration with the existing user interface.
- Mobile applications (iOS,Android): integrated into mobile applications using native SDKs, enabling secure and reliable identity verification on mobile devices.
The choice of platform depends on the specific needs of the application or organization. For web applications, embedding XpressID in an iframe is often the simplest and most straightforward approach. For mobile applications, using native SDKs ensures optimal performance and compatibility with various devices and operating systems.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| platform | string | Yes | - | "web", "android", "ios" |
Language¶
The language setting for XpressID plays a crucial role in ensuring that users experience the onboarding process in a language that is familiar and comfortable to them. By default, XpressID utilizes the system/browser language to determine the appropriate default texts. If the system/browser language is either English (en) or Spanish (es), the corresponding default texts will be applied. However, if the system/browser language is not English or Spanish, XpressID will fall back to English as the default language, ensuring that users receive texts in a language they can understand.
When customizing texts within the setup sections, it's important to note that these customized texts will override the default texts included within XpressID. This feature allows for extensive personalization and localization of the onboarding experience, catering to specific cultural or regional preferences.
In instances where all texts are intended to be customized, there's no need to explicitly specify the language setting. The default language logic will be bypassed, and all text customizations will take precedence. This approach provides complete flexibility in tailoring the onboarding process to the desired language and cultural context.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| language | string | No | en or es by system/browser language |
"en", "es" |