🆔Moroccan National ID (MRZ & Barcode)

This API provides Data Extraction for the Moroccan National ID document, for both MRZ and Barcode NIDs.

Moroccan National ID 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	mar_nid_ocr
data	object	Object containing the parameters below: { "front_img": , # optional default is "" "back_img": , # optional default is "" "bundle_key": , "lang": # optional default is "en" }	Please note thatimg cannot be empty (i.e., missing or an empty string "").

200 Successful

{
    "result": {
        "first_name": {
            "arabic": <string>,
            "latin": <string>
        },
        "last_name": {
            "arabic": <string>,
            "latin": <string>
        },
        "birth_place": {
            "arabic": <string>,
            "latin": <string>
        },
        "father_name": {
            "arabic": <string>,
            "latin": <string>
        },
        "mother_name": {
            "arabic": <string>,
            "latin": <string>
        },
        "address": {
            "arabic": <string>,
            "latin": <string>
        },
        "birth_date": <string>,
        "expiration_date": <string>,
        "gender": <string>,
        "civil_status_num": <string>
    },
    "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"
}

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_nid_ocr', 
    '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())