✈️Passport

---

This API provides Data Extraction for Travel Passport documents, particularly the identity page containing the individual's information.

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/ocr/

Headers

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

Request Body

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

200 Successful

{
    "result": {
        "name": '<string>',
        "surname": '<string>',
        "passport_number": '<string>',
        "expiration_date": '<string>',
        "date_of_birth": '<string>',
        "sex": '<string>',
        "nationality":'<string>',
        "validity": '<int>'
    },
    "transaction_id": '<string>',
    "trials_remaining": '<int>'
}

400 Missing input data

{
    "message": "Bad Request – invalid request received (e.g. missing Bundle key, required parameters or invalid json) | Make sure all the required parameters are included"
}

401 Invalid bundle key

{
    "message": "Unauthorized – your Bundle key is invalid"
}

403 Access token error

{
    "message": "Forbidden – specified access_token could not be found"
}

404 Check the endpoint

{
    "message": "Not Found"
}

415 The format should be base64

{
    "message": "Unsupported Media Type"
}

422 Check Valify error codes

{
    "message": "<error-description>",
    "error_code": <valify-error-code>
}

500 Contact us

{
    "message": "Internal Server Error"
}

---

Integration

Postman

1. Download the JSON file from here.

1KB

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

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

import requests
import base64

def base64_encode(file_name):
    with open(file_name, "rb") as image_file:
        encoded_string = base64.b64encode(image_file.read()).decode()
        return encoded_string
    return ""

image = base64_encode('<image path>')
token = "<token>" # Place your token here
data = {
    'document_type': 'passport', 
    'data':
    {
        'img': image,
        'bundle_key': '<bundle key>', # Place your bundle key here
        'lang': '<str>' # optional
    }
}

r = requests.post("https://valifystage.com/api/v1/ocr/",
        json=data,
        headers={'Authorization': 'Bearer %s' % token}
    )
                      
print(r.json())