GET
/
digilocker
/
document
/
{document_type}
{
  "care_of": "S/O: Fakkirappa Dollin",
  "dob": "02-02-1995",
  "gender": "M",
  "name": "Mallesh Fakkirappa Dollin",
  "photo_link": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHB",
  "reference_id": 408,
  "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"
  },
  "uid": "xxxxxxxx5647",
  "verification_id": "test001"
}

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.

Path Parameters

​
document_type
string
default:
AADHAAR
required

It is the type of document to be verified.

Query Parameters

​
reference_id
integer
default:
12345

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
default:
ABC000123

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

Response

200 - application/json

Success response for Get DigiLocker Document API

​
care_of
string

It displays the name of the parent or guardian.

​
dob
string

It displays the date of birth of the individual.

​
gender
string

It displays the gender of the individual.

​
name
string

It displays the name of the individual.

​
photo_link
string

It displays the link to the photo of the individual present in the document.

​
reference_id
integer

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

​
split_address
object

It contains the address information in individual components.

​
uid
string

It displays the unique number assigned to the individual when applying for the aadhaar card.]

​
verification_id
string

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

Was this page helpful?

Create DigiLocker URLVerify