ACR Card

5 min

Introduction

The Alient certificate of registration(ACR card) extraction API allows you to extract relevant information from the ACR 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": "acrCard",
    "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., "acrCard" 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": "acrCard",
    	"result": {
            "serialNumber": "...serial number on the card...",
            "acrNo": "...acr number...",
            "certOfRes": "...certOfRes...",
            "visaType": "...visa type...",
            "issueDate": "...issue date...",
            "expiryDate": "...expiry date...",
            "visaIssueDate": "...visa issue date...",
            "visaExpiryDate": "...visa expiry date...",
            "address": "...address...",
            "ssrn": "...ssrn...",
            "name": "...name...",
            "surname": "...surname...",
            "countryCode": "...country code as on the card...",
            "civilStatus": "...civil status...",
            "dob": "...Date of Birth...",
            "sex": "...sex..."
        }
    }

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 acrCard in this case
result	The verification result, containing the following fields:
serialNumber	Serial Number
acrNo	acrNo
certOfRes	cert. of res. as on the card
visaType	Type of Visa
issueDate	Card Issue Date
expiryDate	Card Expiry Date
visaIssueDate	Visa Issue Date
visaExpiryDate	Visa Expiry Date
address	Address as on the card
ssrn	ssrn
surname	surname
name	name
countryCode	country code as on the card
civilStatus	civil status
dob	date of birth
sex	sex