Passports

📝 Note: The Personal-ID-Number and Religion fields in passport documents are optional — they may or may not appear in the OCR response. For example:

• Included: Passports from countries like Malaysia and South Korea

• Not included: Many other countries do not include these fields in their passport format.

Request

{
    "operations": ["ocr"],
    "payload": {
        "partnerTrxId": "{{$guid}}",
        "groupId":"{{$guid}}",
        "country": "KOR",
        "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": "ae31c00c-404c-4129-bd34-17ad470583a3",
    "partnerTrxId": "dcc75297-bb57-49b8-84cf-b5e10de608a5",
    "groupId": "0a7d2eca-4829-4d7c-93cb-85f144c60e01",
    "card": {
        "country": "South Korea",
        "type": "PASSPORT",
        "isoAlpha3CountryCode": "KOR",
        "isoAlpha2CountryCode": "KR"
    },
    "ocrResult": {
        "data": {
            "idNumber": {
                "value": "Id-Number"
            },
            "personalIdNumber": {
                "value": "Personal Id Number"
            },
            "name": {
                "value": "Name from passport"
            },
            "dob": {
                "value": "Date of birth in YYYYMMDD format"
            },
            "gender": {
                "value": "Gender from passport (M/F/O)"
            },
            "placeOfBirth": {
                "value": "Place of birth from passport"
            },
            "dateOfExpiry": {
                "value": "Date of expiry"
            },
            "dateOfIssue": {
                "value": "Date of Issuance"
            },
            "citizenship": {
                "value": "citizenship from passport"
            },
            "religion": {
                "value": "religion from passport"
            },
            "issuerName": {
                "value": "issuer name from passport"
            },
            "issuerCountry": {
                "value": "issuer country from passport"
            },
            "issuingAuthority": {
                "value": "issuing authority from passport"
            },
            "portraitImage":"Base64 encoded cropped face image from passport"
        }
    }
}