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¶
Language management plays a key role in ensuring that each user experiences the onboarding process in a familiar and comfortable way.
1. Automatic Language Detection¶
XpressID includes an automatic language detection system that automatically identifies and applies the user's system or browser language. The following languages are supported:
- Catalan (
ca) - Basque (
eu) - Galician (
gl) - Italian (
it) - Portuguese (
pt) - Brazilian Portuguese (
pt-BR) - German (
de) - Spanish (
es) - English (
en)
If the detected language is one of the supported languages listed above, XpressID will automatically display the interface in that language. If the detected language is not supported, XpressID will fall back to English (en) to ensure that content remains readable.
2. Forcing a Specific Language¶
To enforce a fixed language regardless of the user's system or browser settings, you can use the language property:
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| language | string | No | Detected by system/browser | The possible values can be consulted here |
This is useful for providing a consistent experience in controlled environments.
3. Customizing Unsupported Languages¶
To display the interface in a language that is not supported by default, all texts must be manually customized in the desired language.
Custom texts fully override XpressID’s built-in defaults, enabling complete localization tailored to specific cultural or regional needs.
4. Using customLanguage¶
When all interface texts are customized, it is recommended to define the customLanguage property, specifying the language in which the custom texts are written (e.g., "fr" for French or "es-MX" for Mexican Spanish).
- The
customLanguagevalue must follow the BCP 47 language tag standard, which allows you to specify language, region, and script subtags (e.g.,"es-MX"for Mexican Spanish or"zh-Hant"for Traditional Chinese). - This ensures accessibility for screen readers and other assistive technologies by correctly indicating the language of the content.
| Property | Type | Required | Default Value | Possible Values |
|---|---|---|---|---|
| customLanguage | string | No | - | Depending on which language the texts are translated into. Examples here |