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.
{
"data": {
"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.
{
"data": {
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document",
"selfie"
],
"core": {
"confirmProcess": true
},
"options": {
"document": {
"captures": [
{"documentTypes":["XX"]}
]
}
}
}
}
}
Any document + Selfie active¶
{
"data": {
"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.
{
"data": {
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": [
"document"
],
"core": {
"confirmProcess": true
}
}
}
}
Document capture with autoclassified selected by user¶
{
"data": {
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"stages": ["document"],
"core": {
"confirmProcess": true
},
"options": {
"document":{
"captures": [
{"documentTypes":["ES_IDCard_2006","XX_Passport_YYYY","ES_IDCard_2021"]}
]
}
}
}
}
}
Document capture with nfc¶
{
"data": {
"platform": "ios",
"operationMode": "idv",
"flowSetup": {
"stages": ["document"],
"core": {
"confirmProcess": true
},
"options": {
"document":{
"captures": [
{
"documentTypes":["ES_IDCard_2006"],
"nfc": {
"enabled": true
}
}
]
}
}
}
}
}
Custom document types¶
{
"data": {
"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¶
{
"data": {
"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¶
{
"data": {
"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"
]
}
}
}
}
}
Multiple document capture¶
Any document¶
This example throw two document captures and supports any document.
{
"data": {
"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.
{
"data": {
"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.
{
"data": {
"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"]}
]
}
}
}
}
}
Extended example¶
{
"data": {
"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": {
"Default": 0,
"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": {
"fuzziness": 0.5,
"types": [
"pep",
"sanction"
]
}
}
}
}
}
AUTHENTICATION¶
This section contains parameters that apply to the authentication configuration.
{
"data": {
"platform": "web",
"operationMode": "authentication",
"flowSetup": {
"stages": ["selfie"],
"core": {
"selfieImage": "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
},
"options": {
"selfie": {
"liveness": "passive"
}
}
}
}
}
AGE VERIFICATION¶
This section contains parameters that apply to the age verification configuration.
{
"data": {
"platform": "web",
"operationMode": "ageVerification",
"flowSetup": {
"stages": ["document", "selfie"],
"core": {
"ageThreshold": 21
}
}
}
}
RESUME¶
This section contains parameters that apply to the resume configuration.
{
"data": {
"operationMode": "resume",
"flowSetup": {
"core": {
"validationId": "1234567890"
}
}
}
}