Guide to migrate V1 to V2¶
This guide will help you migrate your XpressID V1 to XpressID V2.
Authentication¶
The token request has changed. Please update the new URL and the method of making the request. You can verify the new request here
The new URLs for WORK environment is: https://api-work.eu.veri-das.com/xpressid/api/v2/token
CLIENT_ID and CLIENT_SECRET are no longer provided for token request; it now operates under API_KEY.
Configuration¶
The configuration has changed. Below is a migration guide for the configuration.
Example¶
V1¶
IDV¶
{
"contextualData": {
"id": "1234567890",
"region": "Madrid"
},
"flowId": "seldoc_document_selfiealive_video",
"selfieChallenge": true,
"callbackData": {
"ocr": true,
"reverseImage": true,
"obverseImage": true,
"selfieImage": true
},
"mobileQrRedirect": "https://yourDomain.com",
"mobileQrParams": {
"sessionid": "1672632",
"language": "es"
},
"timestamp": true,
"timestampRequired": false,
"timestampAuthority": "standard",
"scoresConfiguration": {
"minimumAcceptableAge": 18
},
"videoDocComparison": true,
"scores": false,
"confirm": false,
"seldocCountryFilter": [
"ES",
"IT",
"MX",
"CA",
"US"
],
"seldocTypeFilter": [
"IDCard"
],
"seldocGeolocation": false,
"seldocDefaultCountry": "ES",
"pepAndAml": true,
"identityVerification": {
"service": "ESMinistry",
"applicationCode": "xxxxxxx"
}
}
IDV + Esign¶
{
"documentType": "ES2_ID",
"flowId": "document_selfie",
"confirm": true,
"esign": {
"title": "veridas contract",
"signers": [
{
"name": "tester",
"email": "tester@veridas.com"
}
],
"library_document_ids": [
"9b039554-6553-4565-ab5e-885316823d27"
]
}
}
AUTHENTICATION¶
{
"flowId": "selfie",
"authentication": {
"method": "auth",
"selfie": "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
}
}
AGE VERIFICATION¶
{
"flowId": "selfie_document",
"ageVerification": {
"ageThreshold": 21
}
}
V2¶
IDV¶
{
"platform": "web",
"operationMode": "idv",
"flowSetup": {
"core": {
"confirmProcess": false,
"contextualData": {
"id": "1234567890",
"region": "Madrid"
}
},
"stages": [
"qr",
"document",
"selfie",
"video",
"pepSanctions",
"timestamp"
],
"options": {
"qr": {
"redirectionUrl": "https://yourDomain.com/?sessionid=1672632&language=es"
},
"document": {
"captures": [
{
"documentTypes": [
"SelectedByUser"
],
"scoresConfiguration": {
"minimumAcceptableAge": 18
},
"documentSelector": {
"countryFilter": [
"ES",
"IT",
"MX",
"CA",
"US"
],
"documentKindFilter": [
"IDCard"
],
"setup": {
"geolocation": false,
"countryChooser": {
"defaultCountry": "ES"
}
}
}
}
]
},
"selfie": {
"liveness": "active",
"challengeLength": 2
},
"video": {
"videoDocComparison": true
},
"pepSanctions": {
"fuzziness": 0,
"types": [
"pep",
"sanction"
]
},
"identityVerification": {
"services": [
"ESMinistry"
],
"applicationCode": "xxxxxxx"
},
"timestamp": {
"required": true,
"authority": "standard"
}
}
}
}
IDV + Esign¶
{
"platform": "web",
"operationMode": "idv",
"language": "es",
"flowSetup": {
"core": {
"confirmProcess": true
},
"stages": [
"document",
"selfie",
"esign"
],
"options": {
"document": {
"captures": [
{
"documentTypes": [
"ES2_ID"
]
}
]
},
"esign": {
"title": "veridas contract",
"signers": [
{
"name": "tester",
"email": "tester@veridas.com"
}
],
"libraryDocumentIds": [
"9b039554-6553-4565-ab5e-885316823d27"
]
}
}
}
}
AUTHENTICATION¶
{
"platform": "web",
"operationMode": "authentication",
"flowSetup": {
"stages": ["selfie"],
"core": {
"selfieImage": "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
},
"options": {
"selfie": {
"liveness": "passive"
}
}
}
}
AGE VERIFICATION¶
{
"data": {
"platform": "web",
"operationMode": "ageVerification",
"flowSetup": {
"stages": ["document", "selfie"],
"core": {
"ageThreshold": 21
}
}
}
}