Examples¶
IDV¶
This section contains parameters that apply to the IDV operation mode.
Single document capture¶
Any document¶
This example throw a document capture and supports any document.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"]}
]
}
}
}
}
Any document + Selfie passive¶
This example throw a document capture plus selfie capture.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document",
"selfie"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"]}
]
}
}
}
}
Any document + Selfie active¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": ["document", "selfie"],
"core": {
"confirmProcess": true
},
"options": {
"document":{
"captures": [
{"documentTypes":["XX"]}
]
},
"selfie": {
"liveness": "active",
"challengeLength": 2
}
}
}
}
Document selected by user¶
This example throw a document capture with a document selected by user.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
}
}
}
Autoclassification selector with generic passport¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": ["document"],
"core": {
"confirmProcess": true
},
"options": {
"document":{
"captures": [
{"documentTypes":["ES_IDCard_2006","XX_Passport_YYYY","ES_IDCard_2021"]}
]
}
}
}
}
Autoclassification selector with specific passport¶
{
"platform":"web",
"operationMode":"idv",
"flowSetup":{
"core":{
"confirmProcess":true
},
"stages":["document"],
"options":{
"document":{
"captures":[
{"documentTypes":["XX", "ES_Passport_YYYY"]}
]
}
}
}
}
Autoclassification selector with specific and generic passport¶
{
"platform":"web",
"operationMode":"idv",
"flowSetup":{
"core":{
"confirmProcess":true
},
"stages":["document"],
"options":{
"document":{
"captures":[
{"documentTypes":["ES2_ID", "MX_Passport_YYYY", "XX_Passport_YYYY"]}
]
}
}
}
}
Document capture with nfc¶
{
"platform": "ios",
"operationMode": "idv",
"flowSetup": {
"stages": ["document"],
"core": {
"confirmProcess": true
},
"options": {
"document":{
"captures": [
{
"documentTypes":["ES_IDCard_2006"],
"nfc": {
"enabled": true
}
}
]
}
}
}
}
Custom document types¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{
"documentTypes": [
"ES_IDCard_2006",
"ES_IDCard_2015",
"ES_IDCard_2021"
]
}
]
}
}
}
}
Any document + Selfie passive + Video¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"core": {
"confirmProcess": true
},
"stages": [
"document",
"selfie",
"video"
],
"options": {
"document": {
"captures": [
{
"documentTypes": [
"XX"
]
}
]
}
}
}
}
Any document + Selfie active + Video¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document",
"selfie",
"video"
],
"core": {
"confirmProcess": true
},
"options": {
"document":{
"captures": [
{"documentTypes":["XX"]}
]
},
"selfie": {
"liveness": "active",
"challengeLength": 2
}
}
}
}
Document selected by user + Selfie passive + esign process¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"core": {
"confirmProcess": true
},
"stages": [
"document",
"selfie",
"esign"
],
"options": {
"document": {
"captures": [
{
"documentTypes": [
"SelectedByUser"
]
}
]
},
"esign": {
"title": "Test esign",
"signers": [
{
"name": "YOUR_NAME",
"email": "test@veridas.com"
}
],
"libraryDocumentIds": [
"2b5610e7-673e-4fca-a49c-078218501634"
]
}
}
}
}
Document capture with country-specific passport¶
The following JSON configuration shows how to set up a document capture step that accepts a country-specific passport type. In this example, the Venezuelan passport (VE_Passport_YYYY) is included alongside the generic passport type (XX_Passport_YYYY). When the autoclassifier detects a Venezuelan passport, it resolves the document to VE_Passport_YYYY instead of the generic XX_Passport_YYYY. Supported country-specific values: ES_Passport_YYYY, MX_Passport_YYYY, VE_Passport_YYYY, MA_Passport_YYYY, IT_Passport_YYYY, CO_Passport_YYYY, RO_Passport_YYYY.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{
"documentTypes": [
"XX",
"VE_Passport_YYYY",
"XX_Passport_YYYY"
]
}
]
}
}
}
}
Special passport with two captures¶
The following JSON configuration shows the specific setup for the Dutch passport (NL_Passport). This configuration is required to enable a two-step process where the second page is captured manually in a vertical (portrait) orientation. It includes the mandatory activation of manual capture, the deactivation of the document selector, and the necessary text overrides to guide the user through the process:
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"core": {
"confirmProcess": true
},
"stages": [
"document"
],
"options": {
"document": {
"captures": [
{
"documentTypes": [
"NL_Passport_YYYY"
],
"setup": {
"manualCaptureButtonDelay": 5000,
"manualCaptureShow": true
}
}
]
}
}
},
"texts": {
"document": [
{
"step": 1,
"instructions": {
"reverse": {
"title": "Show the top page of the passport and capture manually.",
"subtitle": "Rotate your passport vertically and press the capture button."
}
}
}
]
}
}
Multiple document capture¶
Any document¶
This example throw two document captures and supports any document.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"]},
{"documentTypes":["XX"]}
]
}
}
}
}
Any document + Selfie passive¶
This example throw two document captures plus selfie capture.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document",
"selfie"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"]},
{"documentTypes":["XX"]}
]
}
}
}
}
Any document + Document Selector + Autoclassification Selector¶
This example throw two document captures plus selfie capture.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document",
"selfie"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"]},
{"documentTypes":["SelectedByUser"]},
{"documentTypes":["ES_IDCard_2015","XX_Passport_YYYY"]}
]
}
}
}
}
Excluded document types¶
This example throws a document capture that accepts any document type except the ones listed in excludedDocumentTypes.
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"],"excludedDocumentTypes":["ES_IDCard_2006"]}
]
}
}
}
}
Extended example¶
{
"operationMode": "idv",
"platform": "web",
"language": "en",
"flowSetup": {
"stages": [
"document",
"selfie",
"video",
"timestamp",
"qr",
"pepSanctions",
"identityVerification"
],
"core": {
"confirmProcess": true,
"contextualData": {
"id": "1234567890",
"name": "John",
"lastName": "Doe"
}
},
"options": {
"document": {
"extendedCoverage": true,
"captures": [
{
"scoresConfiguration": {
"minimumAcceptableAge": 18,
"maximumAcceptableTimeSinceExpiration": 30,
"modifiers": {
"ScoreGroup-PrintAttackTest": 1,
"ScoreGroup-ReplayAttackTest": 1,
"ScoreGroup-PhotoAuthenticity": 1
}
},
"documentTypes": [
"XX"
]
}
]
},
"selfie": {
"liveness": "active",
"challengeLength": 2
},
"timestamp": {
"required": true,
"authority": "standard"
},
"qr": {
"redirectionUrl": "https://www.example.com/v2/?id=1234567890"
},
"identityVerification": {
"services": [
"ESMinistry"
],
"applicationCode": "xxxxxxxx"
},
"pepSanctions": {
"types": [
"pep",
"sanction"
]
}
}
}
}
AUTHENTICATION¶
Enrollment¶
This section contains parameters that apply to the enrollment configuration.
For Selfie passive enrollment:
{
"platform":"web",
"operationMode":"idv",
"flowSetup":{
"core":{
"confirmProcess":true
},
"stages":[
"selfie"
],
"options":{
"selfie":{
"liveness":"passive"
}
}
}
}
For Selfie active enrollment:
{
"platform":"web",
"operationMode":"idv",
"flowSetup":{
"core":{
"confirmProcess":true
},
"stages":[
"selfie"
],
"options":{
"selfie":{
"liveness":"active",
"challengeLength":2
}
}
}
}
Authentication¶
This section contains parameters that apply to the authentication configuration.
For Selfie passive authentication
{
"platform": "web",
"operationMode": "authentication",
"flowSetup": {
"stages": ["selfie"],
"core": {
"selfieImage": "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
},
"options": {
"selfie": {
"liveness": "passive"
}
}
}
}
For Selfie active authentication
{
"platform":"web",
"operationMode":"authentication",
"flowSetup":{
"stages":[
"selfie"
],
"core":{
"selfieImage":"data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
},
"options":{
"selfie":{
"liveness":"active",
"challengeLength":2
}
}
}
}
AGE VERIFICATION¶
This section contains parameters that apply to the age verification configuration.
{
"platform": "web",
"operationMode": "ageVerification",
"flowSetup": {
"stages": ["document", "selfie"],
"core": {
"ageThreshold": 21
}
}
}
RESUME¶
This section contains parameters that apply to the resume configuration.
{
"platform": "web",
"operationMode": "resume",
"flowSetup": {
"core": {
"validationId": "previous_validation_id"
}
}
}