Aadhaar OCR API reference

Aadhaar OCR

Reads an Aadhaar card from photos or a PDF: name, date of birth, gender, number and address.

Endpoint

POST https://api.finovel.in/v1/aadhaar-ocr

Charged only when the call succeeds. Errors are never charged. See how every API works for keys, retries and status codes.

Request fields

Field	Type	Required	Description
`front`	file	No	Front photo
`back`	file	No	Back photo
`pdf`	file	No	Aadhaar PDF
`pdf_password`	text	No	PDF password. Only for a password-protected PDF.

Example request

curl -X POST https://api.finovel.in/v1/aadhaar-ocr \
  -H "Authorization: Bearer fin_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{}'

Response fields

Inside data:

Field	Description
`name`	Name
`dateOfBirth`	Date of birth
`gender`	Gender
`aadhaarNumber`	Aadhaar number
`address.formattedAddress`	Address
`address.pincode`	PIN code
`verification.aadhaarChecksumValid`	Check digit valid
`verification.requiresManualReview`	Needs manual review

Example response from the sandbox

{
  "request_id": "req_...",
  "success": true,
  "status": "success",
  "environment": "sandbox",
  "message": "OK",
  "data": {
    "name": "SANDBOX TEST USER",
    "gender": "MALE",
    "address": {
      "pincode": "560001",
      "formattedAddress": "1 Test Street, Bengaluru, Karnataka"
    },
    "dateOfBirth": "1990-01-01",
    "verification": {
      "aadhaarChecksumValid": true,
      "requiresManualReview": false
    },
    "aadhaarNumber": "XXXXXXXX0124"
  },
  "error": null,
  "charged_paise": 0
}

Sandbox scenarios

With a test key, this API can return:

Card read (default)