GET
/
digilocker
/
document
/
{document_type}
curl --request GET \
  --url https://sandbox.cashfree.com/verification/digilocker/document/{document_type} \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
"reference_id": 408,
"verification_id": "test001",
"status": "SUCCESS",
"uid": "xxxxxxxx5647",
"care_of": "S/O: Fakkirappa Dollin",
"dob": "02-02-1995",
"gender": "M",
"name": "Mallesh Fakkirappa Dollin",
"photo_link": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHB",
"split_address": {
"country": "India",
"dist": "Haveri",
"house": "Shri Kanaka Nilaya",
"landmark": "",
"pincode": "581115",
"po": "Ranebennur",
"state": "Karnataka",
"street": "Umashankar Nagar 1st Main 5th Cross",
"subdist": "Ranibennur",
"vtc": "Ranibennur"
},
"xml_file": "<xml file link with 48hrs expiry>"
}

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.

Path Parameters

document_type
enum<string>
required

It is the type of document to be verified.

Available options:
AADHAAR,
PAN,
DRIVING_LICENSE

Query Parameters

reference_id
integer

It is the unique ID created by Cashfree Payments that you receive in the response of Create DigiLocker URL API. format: int64

verification_id
string

It is the unique ID you created to identify the Create DigiLocker URL API request.

Response

200
application/json

Success response for retrieving the document from DigiLocker

The response is of type object.