Documentation
  • Introduction
  • ⚡Quick Guide
  • APIs
    • 🇦🇪UAE Resident ID OCR
    • 🔑OAuth Token
    • 🆔National ID OCR
      • 🔁API Response
    • 🧑‍💼Face Match
      • Face Match (Two Images)
      • Face Match (Image & Transaction ID)
    • ✈️Passport
    • ✈️Libyan passport
    • 🚗Car License
    • ↔️Transliteration
      • National ID Transliteration
      • Commercial Register Translation
      • Names Transliteration
    • 🏫Know Your Business (eKYB)
      • 📖Data Extraction & Verifications
        • Egyptian Commercial Register ID OCR
          • ✅With Verification
        • Egyptian Tax Card OCR
    • 📄Valify Sanction Shield
      • Sanction Shield v2.1.0
    • Sanction Shield v2.0.0
    • 🛡️Supported lists
    • ❓Transaction Inquiry
    • 📷Fetch Images
    • 🔒OTP
      • 📲Send Phone OTP
      • ✅Verify Phone OTP
      • 📥Send Email OTP
      • ✅Verfiy Email OTP
    • Response Data Validation
  • Error Codes
    • Valify Error Codes
    • HTTP Codes
  • References
Powered by GitBook
On this page
  • Libyan Passport OCR
  • Integration
  1. APIs

Libyan passport


This API provides Data Extraction for Libyan 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.

Libyan 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

lby_passport

data

object

Object containing the parameters below: { img: <base64 str>, bundle_key: <str>, lang: <str> }

            
{
  "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>'
  },
  
  "transaction_id": '<string>',
  "trials_remaining": '<int>'
}
{
    "message": "Bad Request – invalid request received (e.g. missing Bundle key, required parameters or invalid json) | Make sure all the required parameters are included"
}
{
    "message": "Unauthorized – your Bundle key is invalid"
}
{
    "message": "Forbidden – specified access_token could not be found"
}
{
    "message": "Not Found"
}
{
    "message": "Unsupported Media Type"
}
{
    "message": "<error-description>",
    "error_code": <valify-error-code>
}
{
    "message": "Internal Server Error"
}

Integration

  1. Download the JSON file from here.

  1. Open Postman and click on Import.

    1. Drop the JSON file.

    1. Click on "Libyan 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".

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': 'lby_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())
PreviousPassportNextCar License

Last updated 12 days ago

✈️
1KB
Documentation - OCR (passport) (v1).postman_collection.json
Passport OCR