Aadhaar

Submit OTP to Verify Aadhaar

Use this API to verify aadhaar by submitting the OTP received on the mobile number linked to the aadhaar information. You also need to enter the reference ID received in the response of Generate OTP to Verify Aadhaar API. View the test data and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.

Response Codes

Sub Code	Status	Message	Next Action
200	SUCCESS	Aadhaar Card Exists	-
400	ERROR	Session expired, please generate a new OTP	Generate a new OTP using Generate OTP to Verify Aadhaar API.
400	ERROR	Invalid Aadhaar Card	-
400	ERROR	Aadhaar not linked to mobile number	Enter a valid aadhaar number linked to a mobile number in the Generate OTP to Verify Aadhaar.
400	ERROR	Otp expired	Generate a new OTP using Generate OTP to Verify Aadhaar API.
400	ERROR	Please enter a valid otp.	Enter the generated OTP.
400	ERROR	Please enter the otp in the request	Enter the generated OTP.
400	ERROR	OTP entered is invalid	Enter the generated OTP.
400	ERROR	Client secret belongs to test environment	Enter the correct environment credentials in the request.
400	ERROR	x-client-id is missing in the request	Enter all the header information in the API request.
401	ERROR	Invalid clientId and clientSecret combination	Enter valid client ID and secret key in the request.
403	ERROR	IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://docs.cashfree.com/docs/ip-whitelisting-verification	Whitelist the IP address.
422	ERROR	Insufficient balance to process this request.	Ensure you have sufficient balance and then process the request.
500	ERROR	Unable to validate, please retry later	Try again after some time.

POST

offline-aadhaar

verify

{
  "ref_id": 70471,
  "status": "VALID",
  "message": "Aadhaar Card Exists",
  "care_of": "S/O: Fakkirappa Dollin",
  "address": "Shri Kanaka Nilaya,,Umashankar Nagar 1st Main 5th Cross,Ranebennur,Haveri-Karnataka,India",
  "dob": "02-02-1995",
  "email": null,
  "gender": "M",
  "name": "Mallesh Fakkirappa Dollin",
  "split_address": {
    "country": "India",
    "dist": "Haveri",
    "house": "Shri Kanaka Nilaya",
    "landmark": null,
    "pincode": 581115,
    "po": "Ranebennur",
    "state": "Karnataka",
    "street": "Umashankar Nagar 1st Main 5th Cross",
    "subdist": "Ranibennur",
    "vtc": "Ranibennur"
  },
  "year_of_birth": 1995,
  "mobile_hash": "ed189eb73247cb90b769e7e8d7dfd2efa4cd6a5ec27602f5d2721c035266568c",
  "photo_link": "<base64 encoded image>",
  "share_code": "1234",
  "xml_file": "<xml file link with 24hrs expiry>"
}

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.

Body

application/json

Find the request parameters to submit the OTP for aadhaar verification

otp

string

default: 267987required

It is the OTP received on the registered phone number for offline aadhaar verification.

ref_id

string

default: 21637861required

It is the unique ID created by Cashfree Payments that you receive in the response of Generate OTP to Verify Aadhaar API.

Response

200 - application/json

Success response for Submit OTP for Aadhaar Verification

ref_id

string

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

status

string

It displays the status of the aadhaar information.

message

string

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

care_of

string

It displays the parent/guardian of the aadhaar card holder.

address

string

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

dob

string

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

string

It displays the email address of the aadhaar card holder.

gender

string

It displays the gender of the aadhaar card holder.

name

string

It displays the name of the aadhaar card holder.

year_of_birth

string

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

mobile_hash

string

It displays the unique information about the device's hardware, software, and other characteristics.

photo_link

string

It displays the URL to the image present in the aadhaar card.

It is the passcode with which we can unzip the xml file

xml_file

string

It is the link which points to the zip file and contains the xml file and has 24 hrs expiry

split_address

object

It contains the address information in individual components.

Was this page helpful?

Generate OTP to Verify Aadhaar Get Employment Details

{
  "ref_id": 70471,
  "status": "VALID",
  "message": "Aadhaar Card Exists",
  "care_of": "S/O: Fakkirappa Dollin",
  "address": "Shri Kanaka Nilaya,,Umashankar Nagar 1st Main 5th Cross,Ranebennur,Haveri-Karnataka,India",
  "dob": "02-02-1995",
  "email": null,
  "gender": "M",
  "name": "Mallesh Fakkirappa Dollin",
  "split_address": {
    "country": "India",
    "dist": "Haveri",
    "house": "Shri Kanaka Nilaya",
    "landmark": null,
    "pincode": 581115,
    "po": "Ranebennur",
    "state": "Karnataka",
    "street": "Umashankar Nagar 1st Main 5th Cross",
    "subdist": "Ranibennur",
    "vtc": "Ranibennur"
  },
  "year_of_birth": 1995,
  "mobile_hash": "ed189eb73247cb90b769e7e8d7dfd2efa4cd6a5ec27602f5d2721c035266568c",
  "photo_link": "<base64 encoded image>",
  "share_code": "1234",
  "xml_file": "<xml file link with 24hrs expiry>"
}

Secure ID APIs

V2

V1

Submit OTP to Verify Aadhaar

Response Codes

Authorizations

Body

Response