POST
/
digilocker
{
  "verification_id": "ABC00123",
  "reference_id": 12345,
  "url": "https://verification-test.cashfree.com/dgl/h7562ci7us0",
  "status": "PENDING",
  "document_requested": [
    "AADHAAR"
  ],
  "redirect_url": "https://www.cashfree.com"
}

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.

Body

application/json

Find the request parameters to create a DigiLocker URL for document verification

document_requested
enum<string>[]
required

It is the list of customer documents required for verification.

Available options:
AADHAAR
verification_id
string
default:
ABC00123
required

It is the unique ID you create to identify the API request. The maximum character limit is 50. Alphanumeric, period (.), hyphen (-). and underscore ( _ ) are allowed.

redirect_url
string
default:
https://www.cashfree.com

It is the URL that you need to provide that takes the user to after completing the DigiLocker journey. It will contain the verification_id that can be used to get the status of the verification.

Response

200 - application/json

Success response for creating a DigiLocker URL for document verification

document_requested
string[]

It displays the list of documents requested for verification.

redirect_url
string

It displays the URL entered in the request that takes the user to after completing the DigiLocker journey.

reference_id
integer

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

status
string

It displays the status of the verification request.

url
string

It displays the URL received to retrieve and verify aadhaar information from DigiLocker.

verification_id
string

It displays the unique ID you created to identify this API request.