AEP Card

5 min

Introduction

The Aerodrome entry permit(AEP card) extraction API allows you to extract relevant information from the AEP 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" : "aepCard",
    "essentials": {
        "files": ["...url of the image of the id card..."]
    }
}'

Input Parameters

Parameter Name	Data Type	Description
task	string	The specific task that needs to be performed, i.e., "aepCard" 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": ["...url of the image of the id card..."]
        },
    	"id": "..id..",
    	"patronId": "...patron id...",
    	"task": "aepCard",
    	"result": {
            "address": "...address...",
            "name": "...name...",
            "permitNumber": "...permit number...",
            "countryCode": "...country code as on the card...",
            "tin": "...tin number...",
            "position": "...position in the organization...",
            "employer": "...employer...",
            "validFromDate": "...valid from date...",
            "expiryDate": "...expiry date...",
            "issueDate": "...issue date..."
        }
    }

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 aepCard in this case
result	The verification result, containing the following fields:
-address	Address as on the card
-name	Name of the individual
-permitNumber	Permit Number as on the card
-countryCode	Country Code
-tin	TIN number as on the card
-position	Position of the individual as on the card
-employer	Employer as on the card
-validFromDate	The Valid From Date
-expiryDate	Expiry Date of the card/ID
-issueDate	Issue Date of the card