Skip to main content
GET
/
digilocker
Get Verification Status
curl --request GET \
  --url https://sandbox.cashfree.com/verification/digilocker \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "user_details": {},
  "status": "PENDING",
  "document_requested": [
    "AADHAAR",
    "PAN",
    "DRIVING_LICENSE"
  ],
  "document_consent": [],
  "verification_id": "ABC00123",
  "reference_id": 12345
}

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

Query Parameters

​
reference_id
integer

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

​
verification_id
string

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

Response

Success response for retrieving the status of the DigiLocker document. verification request

Success response of Get DigiLocker Verification Status

​
user_details
object

It displays the details of the individual(user).

Example:
{
  "name": "John Doe",
  "dob": "02-02-1995",
  "gender": "M",
  "eaadhaar": "Y",
  "mobile": "9999999999"
}
​
status
string

It displays the status of the API request. Possible values are:

  • PENDING
  • AUTHENTICATED
  • EXPIRED
Example:

"PENDING"

​
document_requested
string[]

It contains the information of the requested document(s) for verification.

Example:
["AADHAAR"]
​
document_consent
string[]

It displays the consent of the individual(user) for document verification.

Example:
["AADHAAR"]
​
verification_id
string

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

Example:

"ABC00123"

​
reference_id
integer

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

Example:

1234