Passports

Note: The Personal-ID-Number and Religion fields in passports are optional, meaning they may or may not be present in the response. Some countries, such as Malaysia and South Korea, include these fields in their passports, while others do not.

Request

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": {
        "idNumber": "Id-Number",
        "personalIdNumber": "Personal Id Number",
        "name": "Name from passport",
        "dob": "Date of birth in YYYYMMDD format",
        "gender": "Gender from passport (M/F/O)",
        "placeOfBirth": "Place of birth from passport",
        "dateOfExpiry": "Date of expiry",
        "dateOfIssue": "Date of Issuance",
        "citizenship": "citizenship from passport",
        "religion": "religion from passport",
        "issuerName": "issuer name from passport",
        "issuerCountry": "issuer country from passport",
        "issuingAuthority": "issuing authority from passport"
    }
}