Skip to main content
POST
Submit OTP to Verify Aadhaar

Authorizations

x-client-id
string
header
required

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

x-client-secret
string
header
required

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.

Body

application/json

Find the request parameters to submit the generated OTP

otp
string
default:267987
required

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

Example:

"267987"

ref_id
string
default:21637861
required

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

Example:

"21637861"

Response

Success response for submitting the generated OTP for offline aadhaar verification

ref_id
string

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

Example:

"123456789"

status
string

It displays the status of the aadhaar information. Possible values are:

  • VALID: Successfully fetched Aadhaar details.
Example:

"VALID"

message
string

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

Example:

"123456789"

care_of
string

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

Example:

"Jane Doe"

address
string

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

Example:

"Chimli"

dob
string

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

Example:

"01-01-2000."

email
string

It displays the email hash of the aadhaar card holder.

Example:

"v5c64757c746ytvfb687iyjg"

gender
string

It displays the gender of the aadhaar card holder.

Example:

"Male"

name
string

It displays the name of the aadhaar card holder.

Example:

"John Doe"

year_of_birth
string

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

Example:

"2000"

mobile_hash
string

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

Example:

"v5c64757c746ytvfb687iyjg"

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

Example:

"IMAGE_LINK"

share_code
string

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

Example:

1234

xml_file
string

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

Example:

"https://abc.xyz"

split_address
object

It contains the address information in individual components.