Introducing VIDA Identity Stack: All of VIDA, in one place 🎉
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Passports

Note:

Passport IDV (Identity Verification) results do not include confidence scores. Instead, the response includes:

  • Code 5000 → Indicates the passport was successfully tested for the specified check.

  • A success or failure message → Indicates whether the check passed or failed.

  • Spoof and forgery failure will result in error.

  • Landmark failure will result in a warning.

Passport do not have a IQA response with them.

Request

Request
{
    "operations": ["idVerification"],
    "payload": {
        "partnerTrxId": "{{$guid}}",
        "groupId":"{{$guid}}",
        "country": "IND",
        "idType": "PASSPORT",
        "idSubtype": "N/A",
        "idFrontSideImage":"Base64 encoded image of passport front side"
      },
      "userConsent": {
        "userIp": "226.80.211.232",
        "country": "IND",
        "obtained": true,
        "obtainedAt": "1680700959"
    }

Success Response

HTTP Status Code: 200

Success JSON Response
{
    "transactionId": "unique transaction id generated to identify this transaction",
    "partnerTrxId": "partner transaction id submitted by customer in request",
    "groupId": "partner group id submitted by customer in request",
    "card": {
        "country": "Country",
        "type": "PASSPORT",
        "isoAlpha3CountryCode": "iso Alpha 3 Country Code",
        "isoAlpha2CountryCode": "iso Alpha 2 Country Code"
    },
    "idVerificationResult": {
        "front": {
            "spoofingResult": {
                "message": "success",
                "code": 5000
            },
            "landmarkResult": {
                "message": "success",
                "code": 5000
            },
            "forgeryResult": {
                "message": "success",
                "code": 5000
            }
        }
    }
}

Landmark Response

HTTP Status Code: 200

Landmark Card JSON Response

Spoof Failure Response

HTTP Status Code: 400

Spoof Card JSON Response

Forgery Failure Response

HTTP Status Code: 400

Forgery Card JSON Response

Last updated