POST
/
document
/
aadhaar
{
  "uid": "XXXX-XXXX-3717",
  "name": "Varun Bhupati",
  "yob": "1997",
  "pincode": "474009",
  "address": "S / O : Mahesh Bhupati, 202-parivar daser complex , dal  bazar , Gird , Gwalior , Lashkar City , Madhya Pradesh , 474019",
  "state": " Madhya Pradesh",
  "gender": "Male",
  "father": "Mahesh Bhupati",
  "valid": true,
  "status": "VALID",
  "verification_id": "19bf45c0-8149-4d3f-8d98-c004c4037eba",
  "reference_id": "2345",
  "confidence_score": "",
  "message": "Aadhaar card is valid"
}

Authorizations

x-client-id
string
headerrequired

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
headerrequired

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-api-version
string

It is the API version. To receive the aadhaar seeding status in the response, use any date after 2022-09-12

x-cf-signature
string

Send the signature if IP is not whitelisted

Body

multipart/form-data

Request body schema for Aadhaar Verification via OCR.

verification_id
string
default: 12345678required

It is the unique ID you create to identify the request. The maximum character limit is 50. Only alphanumeric, hyphen (-), period (.), and underscore ( _ ) are allowed.

front_image
file
required

It is the scanned image of the front of the aadhaar card. Allowed file type - JPEG/JPG/PNG. The max file size of both the files is 10MB.

back_image
file

It is the scanned image of the back of the aadhaar card. Allowed file type - JPEG/JPG/PNG. The max file size of both the files is 10MB.

Response

200 - application/json

Success response for Aadhaar Verification via OCR

name
string

It displays the name of the aadhaar card holder.

yob
string

It displays the year of birth of the aadhaar card holder.

father
string

It displays the father's name of the aadhaar card holder.

gender
string

It displays the gender of the aadhaar card holder.

uid
string

It displays the UID information as present in the aadhaar card.

state
string

It displays the name of the state as present in the aadhaar card.

pincode
string

It displays the PIN code information as present in the aadhaar card.

address
string

It displays the address information of the aadhaar card holder.

valid
boolean

It displays whether the aadhaar card is valid or not.

status
string

It displays the status of the aadhaar card.

reference_id
string

It displays the unique ID created by Cashfree Payments for reference purposes.

verification_id
string

It displays the unique ID you created to identify this request.

confidence_score
string

It displays the confidence score for this aadhaar card verification request.

message
string

It displays details about the success or failure of the API request.