Voter ID Front Extraction

Extracts data fields from the front of an Indian Voter ID: ID number, name, guardian relation (father / husband), and the guardian's name.

POSThttps://sandbox/pcs/voter-id/front

Content-Type: application/json

Headers

Header	Type	Required	Description
key	string	Yes	API key issued for authentication.

Request body

Field	Type	Required	Description
recordId	string	Yes	Unique ID you assign to correlate the request with the response.
image	string	Yes	Base64 string / data URI of the Voter ID front image.

Example

POST/pcs/voter-id/front

curl --location 'https://sandbox/pcs/voter-id/front' \
--header 'key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "recordId": "1",
  "image": "data:image/png;base64,<BASE64_STRING>"
}'

200

{
"recordId": "1",
"dataRetrievalStatus": "SUCCESS",
"data": {
  "side": "front",
  "idNumber": "12345",
  "name": "name-string",
  "guardian": "guardian-string",
  "guardianName": "name-string"
},
"utc_time_stamp": "07/11/2024, 07:35:09"
}

Response

Field	Type	Description
recordId	string	Echoes the recordId sent in the request.
dataRetrievalStatus	string	SUCCESS when data was extracted.
data.side	string	Detected side of the document, front.
data.idNumber	string	Voter ID number (EPIC number).
data.name	string	Holder's name.
data.guardian	string	Guardian relation, e.g. Father / Husband.
data.guardianName	string	Guardian's name.
utc_time_stamp	string	UTC timestamp of the response, DD/MM/YYYY, HH:mm:ss.

Error handling

200 on success, 422 on a validation error — see Error handling for the common error shape.