Egypt ID

6 min

Introduction

The Egypt ID extraction API allows you to extract relevant information from the Egypt ID card images. The API uses OCR technology to recognize the text on the image and extract the relevant details.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/....patronid.../foreignidentitiesextractions \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{
    "task": "egyptId",
    "essentials": {
        "files": [
            "...front image url...",
            "...back image url..."
        ]
    }
}'

Input Parameters

Parameter Name	Data Type	Description
task	string	The specific task that needs to be performed, i.e., "egyptId" in this case.
essentials.files	array	The array of files to be used for the extraction process. This array should contain the URLs of the image files.

Sample API Response

   // Expected response
    {
    	"essentials": {
            "files": [
                  "...front image url...",
                  "...back image url..."
              ]
    	},
    	"id": "..id..",
    	"patronId": "...patron id...",
    	"task": "egyptId",
    	"result": {
            "backDataValidity": "...backDataValidity...",
            "backNid": "...backNid...",
            "expiryDate": "...expiryDate...",
            "expired": "...expired...",
            "gender": "...gender...",
            "maritalStatus": "...maritalStatus...",
            "profession": "...profession...",
            "releaseDate": "...releaseDate...",
            "religion": "...religion...",
            "area": "...area...",
            "confidence": "...confidence...",
            "firstName": "...firstName...",
            "frontDataValidity": "...frontDataValidity...",
            "frontNid": "...frontNid...",
            "fullName": "...fullName...",
            "serialNumber": "...serialNumber...",
            "street": "...street..."
        }
    }

Response Parameters

PARAMETERS	DESCRIPTION
essentials	The file URLs for the front and back images of the ID
id	The ID generated for the verification request
patronId	The patron ID for whom the verification is being performed
task	The task that was requested, which is egyptId in this case
result	The verification result, containing the following fields:
backDataValidity	Back data validity
backNid	Back NID
expiryDate	Expiry date of the ID
expired	true/false (If ID is expired)
gender	Gender
maritalStatus	Marital Status
profession	Profession
releaseDate	Release Date
religion	Religion
area	area
confidence	Confidence score
firstName	First name of the individual
frontDataValidity	ID number of the individual
frontNid	Front NID
fullName	Full name of the individual
serialNumber	Serial Number
street	Street

Points to Note:

The following images are not supported:
- Rotated images
- PDFs
- Black and white images
Minimum resolution supported is: 900*600
High size images are not supported
Limited to 4 requests per minute