Get Document from DigiLocker
Use this API to get your customerās document details from DigiLocker.
Response Codes
| Sub Code | Status | Message | Next Action |
|---|---|---|---|
| 200 | SUCCESS | - | - |
| 202 | SUCCESS | Validation in process check after some time | Try again after some time. |
| 400 | ERROR | Please provide verification_id or reference_id | Enter a valid verification_id or reference_id in the request. |
| 400 | ERROR | document_type should be AADHAAR. | Enter the value for document_type as AADHAAR. |
| 400 | ERROR | Digilocker request URL is expired | Create a new DigiLocker URL. |
| 400 | ERROR | Digilocker consent session expired | Create a new DigiLocker consent session. |
| 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. |
| 404 | ERROR | Please enter a valid verification_id | Enter a valid verification ID. |
| 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
Path Parameters
It is the type of document to be verified.
Query Parameters
It is the unique ID created by Cashfree Payments that you receive in the response of Create DigiLocker URL API
It is the unique ID you created to identify the Create DigiLocker URL API request.
Response
Success response for Get DigiLocker Document API
It displays the name of the parent or guardian.
It displays the date of birth of the individual.
It displays the gender of the individual.
It displays the name of the individual.
It displays the link to the photo of the individual present in the document.
It displays the unique ID created by Cashfree Payments for reference purposes.
It contains the address information in individual components.
It displays the unique number assigned to the individual when applying for the aadhaar card.]
It displays the unique ID you created to identify the verification request.
Was this page helpful?