GET
/
digilocker
/
document
/
{document_type}
Get Document
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>"
}
Currently we do not support downloading of full documents through Digilocker API. This feature will be added in the future enhancements.

Authorizations

​
x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

​
x-client-secret
string
header
required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

​
x-cf-signature
string

Send the signature if two-factor authentication is selected as Public Key. More details

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.