Voter ID Verification

Introduction

The Voter ID Verification API allows you to perform voter ID verification for Indian citizens. This API is provided by Signzy Technologies Private Limited and can be accessed through a RESTful API endpoint. With this API, you can verify the authenticity of voter ID details such as EPIC (Electors Photo Identity Card) number, name, and state. This API endpoint returns a JSON response with the verification status and message. In this documentation, we will guide you through the process of accessing and using this API.

Use Cases

Voter ID Verification: The primary use case for this API is to verify the authenticity of a voter's identity using their EPIC (Electors Photo Identity Card) number, name, and state. Election officers or polling agents can use this API to check the validity of the voter's identity before allowing them to vote. This API ensures that only authorized voters are able to cast their votes, thereby ensuring the integrity of the electoral process.
Identity Verification for other services: This API can also be used by other organizations or services to verify the identity of individuals using their EPIC number, name, and state. For example, banks or financial institutions can use this API to verify the identity of customers applying for loans or other financial services. This API can also be used by government agencies to verify the identity of individuals for various services, such as passport applications or welfare programs.

API description

Step 1: Hitting the Identities API

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

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

Sample UAT Curl for Step 1 - Identities

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":[]
}'

Sample Response for Identities

{
  "type": "voterid",
  "email": "[email protected]",
  "callbackUrl": "https://www.w3schools.com",
  "images": [],
  "accessToken": "vmyqpfc4waj3fc0n1o95n23u7gfa37sg9",
  "autoRecognition": [],
  "verification": [],
  "forgeryCheck": [],
  "id": "6490142e3cb362102945c019",
  "patronId": "59536fbbec27ff12d4e9aa1d"
}

Step 2: Hitting the Snoops API

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

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

Sample UAT Curl for Step 2

curl 'https://preproduction.signzy.tech/api/v2/snoops' \
  -H 'content-type: application/json;charset=UTF-8' \
  --data-raw '{
      "service": "Identity",
      "itemId": "<Item ID received in step 1>",
      "accessToken": "<Access Token received in step 1>",
      "task": "verification",
      "essentials":
      {
          "name": "<Name as per Voter ID>",
          "epicNumber": "<EPIC Number as per Voter ID>",
          "state": "<State as per Voter ID>"
      }
  }'

Sample Response for Step 2 - Snoops API

{
    "service": "Identity",
    "itemId": "64901a8e2cb362102945c07e",
    "task": "verification",
    "essentials": {
        "name": "VINOD KXXXX",
        "epicNumber": "NEL516XXXX",
        "state": "Delhi",
        "instance": {
            "id": "64901a8e2cb361002955c07e",
            "callbackUrl": "https://www.w3schools.com"
        }
    },
    "accessToken": "n70tdct1f2xof36oms1vgzipq1nh1cm",
    "id": "64901a8e1cb363002945c07f",
    "response": {
        "name": "VINOD KXXXX",
        "epicNumber": "NEL516XXXX",
        "state": "Delhi",
        "instance": {
            "id": "64901a8e2db362012945c07e",
            "callbackUrl": "https://www.w3schools.com"
        },
        "id": 707,
        "result": {
            "verification": true,
            "message": "Verification completed with positive result"
        }
    }
}

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 does not have permissions for the requested operation.
404	Not Found - The requested resource could not be found.
409	Conflict - There was a conflict with the current state of the server.
500	Internal Server Error - An error occurred on the server while processing the request.
503	Service Unavailable - The server is currently unavailable.

Troubleshooting

Issue	Troubleshooting
Missing or invalid authorization token	Check that the authorization token has been correctly generated and passed in the request headers. Ensure that the token is still valid and has not expired.
Incorrect endpoint or method used	Check that the endpoint being used is correct and that the HTTP method used is appropriate (e.g. POST instead of GET).
Missing required input parameters	Check that all required input parameters have been provided in the request body and that they are correctly formatted. Refer to the API documentation for a list of required parameters and their formats.
Invalid input parameter value	Check that all input parameter values are valid and correctly formatted. Refer to the API documentation for a list of valid parameter values and their formats.
Server errors or unavailability of the service	Check that the server is operational and that there are no issues with the API service. Verify that the request and response payloads meet the API specifications and format.