✈️HRZ Passport

---

This API reads and extracts information directly from the passport identity 
page’s visible content. It does not depend only on the machine-readable zone (MRZ).

The "validity" metric in this API's successful response indicates the validity of the data extracted from the document.

Passport OCR

POST https://valifystage.com/api/v1.5/ocr/

Headers

Name	Type	Description
Content-Type	string	application/json
Authentication	string	Bearer <access-token>

Request Body

Name	Type	Description
document_type	string	egy_passport
data	object	Object containing the parameters below: { img: <base64 str>, bundle_key: <str>, lang: <str> }

Status Codes

✅ 200 Successful

Status Code: 200

Body:
{
    "result": {
        "name": {
            "latin": '<string>',
            "arabic": '<string>'
        },
        "surname": {
            "latin": '<string>',
            "arabic": '<string>'
        },
        "place_of_birth": {
            "latin": '<string>',
            "arabic": '<string>'
        },
        "nationality": {
            "latin": '<string>',
            "arabic": '<string>'
        },
        "sex": {
            "latin": '<string>',
            "arabic": '<string>'
        },
        "address": {
            "latin": '<string>',
            "arabic": '<string>'
        },
        "expiration_date": '<string>',
        "date_of_birth": '<string>',
        "passport_number": '<string>',
        "national_id": '<string>',
        "validity": '<int>'
    },
    "transaction_id": '<string>',
    "trials_remaining": '<int>'
}

400 Missing input data

401 Invalid bundle key

403 Access token error

404 Check the endpoint

415 The format should be base64

422 Check Valify error codes

500 Contact us

---

Integration

🚀Postman

1. Download the JSON file from here.

1KB

Documentation - OCR (passport) (v1).postman_collection.json

Open

Passport OCR

1. Open Postman and click on Import.

   

   1. Drop the JSON file.

   

   1. Click on "Passport" and then click on "Authorization" and replace the <access token> field with your access token and then click on "Body".

1. Click on "Body" then fill in the required data and hit "Send".

🐍Python 3