Extraction API

5 min

Introduction

This API is used to extract Voter Id data from any Indian Voter Id by uploading either front image & back image or URLs of the images as input.

How to call the API

Before going for Auto reading calls, you first need to create an Identity object. Need to pass accessToken and itemid obtained from identity call along with other input parameters

API Input Guidelines

To hit this API front and back images or URLs of the need to given as input.

Sample Curl

Voter ID Extraction

Extracting Voter Id details

POST

https://preproduction.signzy.tech/api/v2/patrons/<patronId>/voterIdV2

curl --location --request POST 'https://signzy.tech/api/v2/patrons/<patronId>/voterIdV2' \
--header 'Authorization: <token>' \
--header 'content-type: application/json' \
--data-raw '{
    "task": "extraction",
    "essentials": {
        "images": [
            "<Front image Url>",
            "<back image Url>"
        ]
    }
}'

Response Parameter

Parameter Name	Description
essentials	Contain essential data for input
essentials.images	Contains Images Url
id	Contains unique Id
patronId	Contains patron Id
task	Extracting voter Id data
result	Contains the output details
result.status	Contains the result status
result.name	Contains name of the voter Id holder
result.fatherName	Contains father name or husband name of the voter Id holder
result.address	Contains address
result.state	Contains state name
result.ageAsOn	Contains Age of the Indentity holder
result.dob	Contains date of birth
result.gender	Contains gender information of the indentity holder
result.yob	Contains year of birth
result.epicNumber	Contains epic number of Voter Id
result.splitAddress.district	Contains district name
result.splitAddress.state	Contains state name
result.splitAddress.city	Contains name of the city
result.splitAddress.pincode	Contains pincode
result.splitAddress.country	Contains Country name
result.splitAddress.addressLine	Contains address house number area etc
result.msg	Contains message of success or failure of the output

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].