GET
/
document
/
aadhaar
{
  "name": "JOHN DOE",
  "father": "JOSH DOE",
  "yob": "1997",
  "gender": "Male",
  "uid": "XXXX-XXXX-3717",
  "pincode": "474009",
  "address": "S / O : JOSH DOE, 202-parivar daser complex , dal  bazar , Gird , Gwalior , Lashkar City , Madhya Pradesh , 474019",
  "state": " Madhya Pradesh",
  "valid": true,
  "status": "VALID",
  "verification_id": "testverificationid",
  "reference_id": "2345",
  "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-cf-signature
string

Send the signature if IP is not whitelisted

Query Parameters

reference_id
string
default: 1358

It is the unique ID created by Cashfree Payments that you receive in the response of Aadhaar Verification via OCR API.

verification_id
string
default: ABC00123

It is the unique ID you created to identify the verification request.

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.