🗂️Saudi Residency Card

This API provides Data Extraction for Saudi Residency Card documents.

Saudi Residency Card 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	Notes
document_type	string	ksa_resident_id
data	object	Object containing the parameters below: { "front_img": <string>, // optional default is "" "bundle_key": <string>, "lang": <string> // optional default is "en" }	Please note that front_img cannot be empty (i.e., missing or an empty string "").

Status Codes

✅200 Successful

{
  "result": {
    "full_name": {
      "arabic": <string>,
       "latin": <string>
    
    },
    "residence_number": {
      "arabic": <string>
       "latin": <string>,
    },
    "version": {
     "arabic": <string>
       "latin": <string>,
    },
    "issue_date": {
      "arabic": <string>,
       "latin": <string>
    },
    "dob":{
     "arabic": <string>,
       "latin": <string>

    },
    "expiry_date": {
      "arabic": <string>,
       "latin": <string>

    },
    "Issue place": {
      "arabic": <string>,
       "latin": <string>

    },
    "profession": {
      "arabic": <string>,
       "latin": <string>

    },
    "nationality": {
      "arabic": <string>,
       "latin": <string>

    },
    "religion": {
      "arabic": <string>,
       "latin": <string>
       
    },"Sponser name":{
     "arabic": <string>,
       "latin": <string>

    }, "barcode number":{
   "arabic": <string>,
    "latin":<string>
  },
  "transaction_id": <string>,
  "trials_remaining": <string>
}

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"
}

🐍Python

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 ""

front_image = base64_encode('<image path>') # Place your front image here
back_image = base64_encode('<image path>') # Place your back image here
token = "<token>" # Place your token here
data = {
    'document_type': 'mar_resident_id', 
    'data':
    {   
        'front_img': front_image,
        'back_img': back_image,
        'bundle_key': '<bundle key>', # Place your bundle key here
        'lang': '<str>' # optional, default: en
    }
}

r = requests.post("https://<base-url>/api/v1/ocr/",
        json=data,
        headers={'Authorization': 'Bearer %s' % token}
    )
                      
print(r.json())