Guide to migrate v2 to v2.1

This guide will help you migrate your XpressID v2 to XpressID v2.1.

Authentication

You can still request the token in the same way.

One option is to request the token using your API_KEY and providing the necessary data within the data field.

Another option is to send configuration data via data and customization files for texts, styles, and image media via files. See details here.

The new URL is: https:/XpressID_API_URL/xpressid/api/v3/token. Please refer to this table to determine which URL to use.

Configuration

The configuration remains the same for both versions, maintaining backward compatibility; you can observe this in the examples. However, customization has changed. It's now handled under the texts, styles, and medias keys. You can see more details about this here.

Example

v2 and v2.1

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": {
                "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": ["92689766-0658-4497-9d1e-ad5f0e54f568"]
            }
        }
    }
}

AUTHENTICATION

{
    "platform": "web",
    "operationMode": "authentication",
    "flowSetup": {
        "stages": ["selfie"],
        "core": {
            "selfieImage": "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
        },
        "options": {
            "selfie": {
                "liveness": "passive"
            }
        }
    }
}

AGE VERIFICATION

{
    "platform": "web",
    "operationMode": "ageVerification",
    "flowSetup": {
        "stages": ["document", "selfie"],
        "core": {
            "ageThreshold": 21
        }
    }
}