✅With Verification

---

This API provides Data Extraction for the Egyptian National ID, along with document verification. The following information is included in this API's response:

• Front Confidence: indicates if the front of the document is real or fake.

• Back Confidence: indicates if the back of the document is real or fake.

• Expired: indicates whether the NID is past its expiry date.

• Front Data Validity: data on the front side is valid or not.

• Back Data Validity: data on the back side is valid or not.

---

Make sure to add the "document_verification_plus" extra in the request body to "true" in order to leverage the verification capability.

Egyptian National ID OCR (w/verification)

POST https://valifystage.com/api/v1.5/ocr/

Headers

Name	Type	Description
Content-Type*	string	application/json
Authentication*	string	Bearer <access-token>

Request Body

Name	Type	Description
document_type*	string	egy_nid
data*	object	Object containing the parameters below: { "extras: ["document_verification_plus"], "front_image": <base64 str>, "back_image": <base64 str>, "bundle_key": <str>, "lang": <str> }

200 Successful

{
    "result": {
        "first_name": '<string>',
        "full_name": '<string>',
        "street": '<string>',
        "front_nid": '<string>',
        "serial_number": '<string>',
        "back_nid":'<string>',
        "release_date": '<string>',
        "gender": '<string>',
        "marital_status": '<string>',
        "profession": '<string>',
        "religion":'<string>',
        "husband_name": '<string>',
        "expired": '<bool>',
        "date_of_birth": '<string>',
        "age", '<int>',
        "birth_governorate": '<string>',
        "police_stations": '<string>',
        "governorate": '<string>',
        "expiry_date": '<string>',
    },
    
   "document_verification_plus": {
        "expired": '<boolean>',
        "front_data_validity": '<boolean>',
        "back_data_validity": '<boolean>',
        "is_front_greyscale": '<boolean>',
        "is_back_greyscale": '<boolean>',
        "review_required": '<list>'
    },
    
    "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"
}

Document Verification Plus Breakdown

The following are possible values that could come in the review required list along with their triggers

1. date_of_birth triggered by an invalid date or incorrect format

2. street when the field value is missing from the response

3. police_station when the field value is missing from the response

4. governorate when the field value is missing from the response

5. birth_governorate triggered by an invalid field format

6. back_nid triggered by an invalid field format

7. front_nid triggered by an invalid field format

8. serial_number triggered by an invalid field format

9. full_name triggered when the field value is missing from the response

10. first_name triggered when the field value is missing from the response

11. expiry_date triggered by an invalid date or incorrect format

12. release_date triggered by an invalid date or incorrect format

13. front_img triggered when is_front_greyscale is true

14. back_img triggered when is_back_greyscale is true