Voter ID OCR API
The Voter ID OCR API allows users to extract voter ID card details automatically from uploaded voter ID images or documents using OCR technology. It retrieves structured information such as voter ID number, holder name, gender, date of birth, address, and other available details quickly and accurately in JSON format.
API Details
Request URL
Request Body Parameters
| Type | Name | Optional | Description |
|---|---|---|---|
| File | file | Required | Upload the Voter ID card image. |
Request Header Parameters
| Type | Name | Value / Description | Optional |
|---|---|---|---|
| String | Content-Type | multipart/form-data | Required |
Sample Code
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://g99.in/api/ocr/voteridocr',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('file'=> new CURLFILE(' --Uploaded File Path-- ')),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import requests
url = "https://g99.in/api/ocr/voteridocr"
payload = {}
files=[
('file',(' --Uploaded File Name-- ',open(' --Uploaded File Path-- ','rb'),'image/png'))
]
headers = {}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://g99.in/api/ocr/voteridocr");
var content = new MultipartFormDataContent();
content.Add(new StreamContent(File.OpenRead(" --Uploaded File Path-- ")), "file", " --Uploaded File Path-- ");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Response
HTTP status code 200
| Key | Type | Description |
|---|---|---|
| reg | String | Registration or identification number of the voter. |
| name | String | Name of the voter ID holder. |
| careOf | String | Parent, spouse, or guardian name mentioned in the card. |
| dob | Date | Date of birth of the voter. |
| age | String | Age of the voter mentioned in the card. |
| gender | String | Gender of the voter ID holder. |
| address | String | Residential address mentioned in the voter ID card. |
Sample Response
Sample response for valid document
{
"valid": true,
"message": null,
"data": {
"reg": "TQR1122334",
"name": "Suvrajyoti Majumder",
"careOf": "Samir Majumder",
"dob": "20/06/2003",
"age": 22,
"gender": "M",
"address": "12, HARISAVA ROAD, BARRACKPUR, TITAGARH, NORTH 24 PARGANAS-700122"
}
}
Error Response
| Parameter | Type | Description |
|---|---|---|
| status | Number | Unique error codes for different errors. Always available. |
| message | String | Error message describing the error. Always Available. |
| error | Boolean | True / False for different errors. Always available. |
Error Codes
| HTTP Status | Error Code | Error Message |
|---|---|---|
| 400 | 4001 | Malformed data or missing required parameter values. |
| 400 | 4002 | File size exceeds 10MB limit. |
| 400 | 4003 | Only JPEG and PNG images are supported. |
| 400 | 4004 | Invalid or corrupted image. |
| 400 | 4005 | Minimum image size should be 200 X 200 pixels. |
| 500 | 5001 | Document processing service is currently unavailable. Please try again later. |
Sample Error Response
{
"message": "Invalid or corrupted image.",
"status": 4004,
"error": True
}
Constraints
-
Only JPEG, PNG images are supported.
-
Minimum image size is 200x200 png for better identification and parsing.
-
Maximum allowed image size is 10 MB.