Egyptian Commercial Register ID OCR

---

Valify's Commercial Register OCR empowers organizations to effortlessly extract accurate and relevant information from Egyptian Commercial Register documents. Our powerful solution automates data extraction in a structured format, ensuring compliance with Egyptian regulatory requirements and streamlining business processes.

Egyptian Commercial Register API

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	egy_cr
data*	object	Object containing the parameters below: { document: <base64 str>, bundle_key: <str>, lang: <str> }

200 Successful

{
    "result": {
        "company_type": '<str>',
        "cr_number": '<str>',
        "cr_unique_number": '<str>',
        "licensing_authority": '<str>',
        "company_name": '<str>',        
        "company_commercial_name": '<str>',
        "incorporation_date": '<str>',
        "renewal_date": '<str>',
        "address": '<str>',
        "owners": '<list>',
        "capital": '<str>',
        "paid_in_capital": '<str>',
        "partners_share_value": '<str>',
        "in_kind_shares_value": '<str>',
        "remaining_capital_pledged": '<str>',
        "document_issue_date": '<str>'
    },
    "transaction_id": '<str>',
    "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

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())
        return encoded_string
    return ""

cr_document = base64_encode('<image path>')
token = "<token>"
data = {
    'document_type': 'egy_cr', 
    'data':
    {   
        'document': <Base64>,
        'bundle_key': '<bundle key>',
        'lang': '<str>' # optional, default: en
    }
}

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