Voter ID extraction

Introduction

The Voter ID Card Details Extraction API provided by Signzy Technologies Private Limited enables users to extract personal information from a scanned copy of a Voter ID card. This API accepts an image of the Voter ID card and returns relevant details such as the voter's name, father's name, address, age, date of birth, gender, EPIC number, and more. Users can integrate this API into their applications to streamline the process of capturing and verifying Voter ID card details.

Use Cases

The Voter ID Card Details Extraction API can be used in a variety of applications, including:

Voter Registration: With the Voter ID Card Details Extraction API, election commissions and other agencies can quickly and accurately verify the identity of voters during the registration process. This can help reduce errors and ensure the integrity of the voter registration process.
KYC Verification: Financial institutions, insurance companies, and other businesses that require Know Your Customer (KYC) verification can use this API to verify customers' identities using their Voter ID cards. This can help streamline the onboarding process and reduce the risk of fraud.
Government Services: The Voter ID Card Details Extraction API can be integrated into various government services to verify the identity of individuals applying for services such as welfare benefits, pensions, and more.
E-commerce: Online shopping platforms can use this API to verify the identity of customers during the registration process, ensuring that only genuine customers can access their services.
Identity Verification: Other applications where identity verification is required, such as membership portals or employee onboarding, can benefit from using the Voter ID Card Details Extraction API.

API description

Identity Object (Step 1)

POST https://preproduction.signzy.tech/api/v2/patrons/<patron-id>/identities

POST https://signzy.tech/api/v2/patrons/<patron-id>/identities

Sample UAT Curl (Step 1)

curl --location 'https://preproduction.signzy.tech/api/v2/patrons/<patron-id>/identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "voterid",
  "email": "[email protected]",
  "callbackUrl": "https://www.w3schools.com",
  "images":
  ["voterID front URL","voterID back URL"]
}'

Sample Production Curl (Step 1)

curl --location 'https://signzy.tech/api/v2/patrons/<patron-id>/identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "voterid",
  "email": "[email protected]",
  "callbackUrl": "https://www.w3schools.com",
  "images":
  ["voterID front URL","voterID back URL"]
}'

Details of the request properties

The request body for the Voter ID Card Details Extraction API should be in JSON format and contain the following fields:

Field	Data Type	Required	Description
task	string	Yes	The type of task to be performed. For this API, the value should be extraction.
essentials	object	Yes	An object containing the list of images to be processed. The object should contain a field named images, which should be an array of image URLs in string format.

Here's a brief description of each input parameter:

Parameter	Type	Required	Description
task	string	Yes	The type of task to be performed. For this API, the value should be extraction.
images	array	Yes	An array of image URLs to be processed. Each URL should be a valid URL pointing to an image file, and the total number of images should not exceed 5. The API only supports JPEG and PNG formats.

Sample response (Step 1)

{
    "type": "voterid",
    "email": "[email protected]",
    "callbackUrl": "https://www.w3schools.com",
    "images": [
        "https://preproduction-persist.signzy.tech/api/files/33038783/download/c571b3ab03a643538df47b59dcf660dd841e2726b3ce46f89ab606acb5cb7a.jpg",
        "https://preproduction-persist.signzy.tech/api/files/33038785/download/02875fafebc4472589624e58eee7b96d08afd3e01bd34326b905fb4d5ec1bab.jpg"
    ],
    "accessToken": "nf1esc7qr68j0kaj0aqru178pzr70nzs",
    "autoRecognition": [],
    "verification": [],
    "forgeryCheck": [],
    "id": "648f2b3c24b362002945ba27",
    "patronId": "646c635c55687d0011ea8950"
}

Property	Example Value	Description
status	"200"	Status code indicating whether the API request was successful.
name	"XXXX"	Name of the voter extracted from the voter ID card.
fatherName	""	Name of the voter's father extracted from the voter ID card.
address	""	Address of the voter extracted from the voter ID card.
state	""	State of the voter extracted from the voter ID card.
ageAsOn	""	Age of the voter extracted from the voter ID card as on the date mentioned.
dob	""	Date of birth of the voter extracted from the voter ID card.
gender	"FEMALE"	Gender of the voter extracted from the voter ID card.
yob	""	Year of birth of the voter extracted from the voter ID card.
epicNumber	""	EPIC number of the voter extracted from the voter ID card.
splitAddress	See below	Object containing the split components of the voter's address.
msg	"success"	Message indicating the success of the API request.
error	See below	Object containing the error details in case of a failed API request.

Here is the tabular format for the splitAddress object:

Property	Example Value	Description
district	[]	List of districts in the voter's address.
state	[[]]	List of states in the voter's address, each element in the list can be a list of multiple states due to ambiguity in the address.
city	[]	List of cities in the voter's address.
pincode	""	Pincode of the voter's address.
country	["IN","IND","INDIA"]	List of countries in the voter's address, with ISO codes.
addressLine	""	Complete address line of the voter's address.

Snoops (Step 2)

POST https://preproduction.signzy.tech/api/v2/snoops

Sample UAT Curl (Step 2)

curl --location 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
      "service": "Identity",
      "itemId": "<ItemID from Step 1>",
      "accessToken": "<Access token from Step 1>",
      "task": "autoRecognition",
      "essentials":{}
}'

Sample Production Curl (Step 2)

curl --location 'https://signzy.tech/api/v2/snoops' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
      "service": "Identity",
      "itemId": "<ItemID from Step 1>",
      "accessToken": "<Access token from Step 1>",
      "task": "autoRecognition",
      "essentials":{}
}'

Sample Response (Step 2)

{
    "service": "Identity",
    "itemId": "648f2b3c2cb362002945ba39",
    "task": "autoRecognition",
    "essentials": {},
    "accessToken": "nf1esc72r78jfkaj0aqry178pzr70nzs",
    "id": "648f3203ebe47d01230c2627",
    "response": {
        "result": {
            "name": "Full Name",
            "fatherName": "Fathers Name",
            "address": "Full Address line",
            "state": "KARNATAKA",
            "ageAsOn": "",
            "dob": "",
            "gender": "",
            "yob": "",
            "epicNumber": "GQF02XXXXX",
            "splitAddress": {
                "district": [
                    "BANGALORE"
                ],
                "state": [
                    [
                        "KARNATAKA",
                        "KA"
                    ]
                ],
                "city": [
                    "BANDAPURA"
                ],
                "pincode": "560049",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "Detailed Address line"
            }
        },
        "url": [
            "https://preproduction-persist.signzy.tech/api/files/33338783/download/c571b3ab03a643538df47b59dcf660dd841e2726b3ce46f89ab606acb5cb729e.jpg",
            "https://preproduction-persist.signzy.tech/api/files/3338785/download/02875fafebc4472589624e58eee7b96d08afd3e01bd34326b905fb4d5ec16.jpg"
        ],
        "callbackUrl": "https://www.w3schools.com",
        "instaneId": "648f2b3c2cb362102945ba29"
    }
}

Error Codes

Error Code	Description
400	Bad Request - The request could not be understood or was missing required parameters.
401	Unauthorized - Authentication failed or user doesn't have permissions for the requested operation.
403	Forbidden - Access denied for the requested resource.
404	Not Found - The requested resource was not found.
422	Unprocessable Entity - The request was well-formed but was unable to be followed due to semantic errors.
429	Too Many Requests - The user has sent too many requests in a given amount of time.
500	Internal Server Error - Something is broken.
502	Bad Gateway - Signzy Technologies' servers are down or being upgraded.
503	Service Unavailable - The service is temporarily unavailable.
504	Gateway Timeout - The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

Troubleshooting

Issue	Solution
Invalid authorization header	Double-check the authorization header in the request and ensure that it is correct.
Invalid or missing image URLs	Ensure that the URLs for each image in the request body are valid and accessible.
Image is not in focus or blurred	Use high-quality images that are in focus and not blurred for better results.
Image is not horizontally aligned	Ensure that the images are horizontally aligned for better results.
Image is not properly cropped	Make sure the images are cropped tightly around the Voter ID card for better results.
Image is too large (>2MB)	Compress the images to ensure that each image is less than 2MB.
Issues with the request headers	Check the request headers and ensure that they are correctly formatted and contain the required information.
Server error	Wait for some time and retry the request after some time.