Skip to main content
POST
/
v2
/
ocr
/
aadhaar
Extract Aadhaar data using OCR
curl --request POST \
  --url https://bgv.konnectnxt.com/api/v2/ocr/aadhaar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_url": "https://example.com/documents/aadhaar-sample.jpg"
}
'
{
  "status": "success",
  "code": 200,
  "message": "Operation completed successfully",
  "data": {
    "extraction_output": {
      "id_number": "836696393224",
      "name_on_card": "Parvez Alam",
      "date_of_birth": "1986-06-20",
      "year_of_birth": "1986",
      "gender": "Male",
      "address": "S/O  Shameem Ansari, 486, Badi Bashi Kalan, Rajpura, Rajpur, Mirzapur, Uttar Pradesh, 231001",
      "street_address": "S/O: Shameem Ansari, 486, Badi Bashi Kalan , Rajpura , Rajpur",
      "house_number": "486",
      "district": "Mirzapur",
      "state": "Uttar Pradesh",
      "pincode": "231001",
      "fathers_name": "Shameem Ansari",
      "is_scanned": false
    },
    "qr_output": {
      "id_number": null,
      "name_on_card": null,
      "date_of_birth": null,
      "year_of_birth": null,
      "gender": null,
      "address": null,
      "street_address": null,
      "house_number": null,
      "district": null,
      "state": null,
      "pincode": null
    }
  },
  "credits_used": 10,
  "credits_remaining": 984076.5
}

​
Description

Extract structured data from Aadhaar cards using advanced OCR technology powered by IDfy. Simply provide the document URL and receive comprehensive details including Aadhaar number, personal information, complete address breakdown, and demographic data. The API intelligently extracts information from both the document image and QR code (if present) to ensure maximum accuracy.

​
Use Cases

This API is valuable for:
  • Digital KYC Onboarding - Automate customer verification by extracting Aadhaar details during account opening or registration processes
  • Loan Applications - Quickly capture applicant identity and address information for credit assessment and verification
  • Address Verification - Extract detailed address components (house number, street, district, state, pincode) for delivery or compliance purposes
  • Identity Authentication - Verify individual identity by extracting name, date of birth, gender, and Aadhaar number from document uploads
  • Document Validation - Detect whether the Aadhaar card is scanned or photographed to assess document quality
  • Compliance Requirements - Extract and store Aadhaar details to meet regulatory KYC/AML obligations
  • Customer Onboarding - Eliminate manual data entry by automatically capturing all required fields from uploaded Aadhaar documents

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
document_url
string<uri>
required

Public URL of the Aadhaar document image (JPG, PNG, or PDF)

Example:

"https://example.com/documents/aadhaar-sample.jpg"

Response

Aadhaar OCR processed successfully

​
status
enum<string>
required

Overall status of the API

Available options:
success,
error
​
code
integer
required

HTTP status code

Example:

400

​
message
string
required

Description of the response or error

Example:

"Invalid request parameters"

​
data
object
required
​
credits_used
integer
required

Represents the total number of credits used in this request.

Example:

3

​
credits_left
integer
required

Represents the remaining credits available for use.

Example:

4040