Create DigiLocker URL
Use this API to create a DigiLocker URL to retrieve and verify aadhaar information of your customer.
Response Codes
| Sub Code | Status | Message | Next Action |
|---|---|---|---|
| 200 | SUCCESS | PENDING | - |
| 400 | ERROR | verification_id is missing in the request. | Enter a valid verification_id in the request. |
| 400 | ERROR | verification_id can include only alphanum, dot, hyphen, and underscores. | Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed. |
| 400 | ERROR | document_requested is missing in the request. | Enter the document required for verification in the request. |
| 400 | ERROR | Requested Document Type canāt be empty | Enter the type of document required for verification in the respective parameter and hit the API. |
| 400 | ERROR | Invalid Document Type Submitted | Enter a valid value for the parameter. |
| 400 | ERROR | Duplicate Document Type Submitted | Enter a valid value for the document_requested parameter. |
| 400 | ERROR | redirect_url should start with https. | Enter a valid redirect URL. |
| 400 | ERROR | redirect_url should be valid url. | Enter a valid redirect URL. |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 400 | ERROR | x-client-id is missing in the request. | Enter all the header information in the API request. |
| 401 | ERROR | Invalid clientId and clientSecret combination | Ensure you enter valid x-client-id and x-client-secret information in the API request. |
| 403 | ERROR | IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://docs.cashfree.com/docs/ip-whitelisting-verification | Whitelist the IP address. |
| 409 | ERROR | verification_id already exists, please provide new verification_id | Enter a unique verification ID to identify the request. |
| 422 | ERROR | Insufficient balance to process this request | Try again with sufficient balance. |
| 500 | ERROR | Unable to process your request. Try again after some time | Try again after some time. |
Authorizations
Client ID. You can find your ID in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
Send the signature if IP is not whitelisted
Body
Find the request parameters to create a DigiLocker URL for document verification
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.
It is the list of customer documents required for verification.
AADHAAR 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
Success response for creating a DigiLocker URL for document verification
It displays the unique ID you created to identify this API request.
It displays the unique ID created by Cashfree Payments for reference purposes.
It displays the URL received to retrieve and verify aadhaar information from DigiLocker.
It displays the status of the verification request.
It displays the list of documents requested for verification.
It displays the URL entered in the request that takes the user to after completing the DigiLocker journey.
Was this page helpful?