Aadhaar OCR API

The Aadhaar OCR API allows users to extract Aadhaar card details automatically from uploaded Aadhaar images or documents using OCR technology. It retrieves structured information such as Aadhaar number, name, date of birth, gender, address, and other available details quickly and accurately in JSON format.

API Details

Request URL

POST

https://g99.in/api/ocr/aadhaarocr

Request Body Parameters

Type	Name	Optional	Description
File	file	Required	Upload the Aadhaar card image.

Request Header Parameters

Type	Name	Value / Description	Optional
String	Content-Type	multipart/form-data	Required

Sample Code

request.php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://g99.in/api/ocr/aadhaarocr',
  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;

request.py

import requests

url = "https://g99.in/api/ocr/aadhaarocr"

payload = {}
files=[
  ('file',(' --Uploaded File Name-- ',open(' --Uploaded File Path-- ','rb'),'image/jpeg'))
]
headers = {}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

request.cs

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://g99.in/api/ocr/aadhaarocr");
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
uuid	String	Unique identification number associated with the Aadhaar record.
vid	String	Virtual ID generated for secure Aadhaar verification.
name	String	Name of the Aadhaar holder.
careOf	String	Care of (C/O) person name mentioned in the address.
dob	Date	Date of birth of the Aadhaar holder.
gender	String	Gender of the Aadhaar holder.
address	String	Residential address mentioned in the Aadhaar card.

Sample Response

Sample response for valid document

response.json

{
    "valid": true,
    "message": null,
    "data": {
        "uuid": "11223344",
        "vid": "919184971895",
        "name": "Raghu",
        "careOf": "S/O Guru",
        "dob": "15/04/1996",
        "gender": "MALE",
        "address": "S/O Guru, swatanrra nagar, Narela, North West Delhi, Delhi - 110040"
    }
}

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

response.json

{
  "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.