🆔Tunisian National ID

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

Tunisian National ID OCR

POST https://sandbox.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	tun_nid_ocr
data	object	Object containing the parameters below: { "front_img": , "back_img": , "bundle_key": , "lang": # optional default is "en" }	Please note that front_img,back_img and bundle_key cannot be empty (i.e., missing or an empty string "").

Status Codes

✅200 Successful

{
    "result": {
        "nid": <string>,
        "last_name": <string>,
        "first_name": <string>,
        "father_name": <string>,
        "husband_name": <string>,
        "birthdate": <string>,
        "birthplace": <string>,
        "mother_name": <string>,
        "profession": <string>,
        "address": <string>,
        "issue_date": <string>,
        "thumbprint_code": <string>,
    },
    "transaction_id": <string>,
    "trials_remaining": <int>

5015 CONTACT_SERVER_ADMIN

{
    "message": "An error occurred. Please try again and if the error persists, please contact us at [e-mail]",
    "error_code": 5015,
    "transaction_id": 1234,
    "trials_remaining": 0
}

5009 INVALID_DATA

{
    "message": "An error occurred. Please try again and if the error persists, please contact us at [e-mail]",
    "error_code": 5009,
    "transaction_id": "1234",
    "trials_remaining": 0
}