Get DigiLocker Verification Status
Use this API to get the status of the DigiLocker verification. You need to enter either the verification ID or reference ID.
Response Codes
| Sub Code | Status | Message | Next Action |
|---|---|---|---|
| 200 | SUCCESS | PENDING | - |
| 200 | SUCCESS | AUTHENTICATED | - |
| 200 | SUCCESS | EXPIRED | Generate a new DigiLocker URL. |
| 200 | SUCCESS | eaadhaar: N | If eaadhaar returns N, one of the user details in the response might be null. Ensure the individual has e-aadhaar availability. |
| 400 | ERROR | Please provide verification_id or reference_id | You need to enter either the verification ID or reference ID. |
| 400 | ERROR | x-client-id is missing in the request. | Enter all the header information in the API request. |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 401 | ERROR | Invalid clientId and clientSecret combination | Enter valid client ID and secret key in the 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 that you created to identify the API request. |
| 404 | ERROR | Please enter a valid reference_id | Enter a valid reference ID that you received in the API response. |
| 422 | ERROR | Insufficient balance to process this request. | Ensure you have sufficient balance and then process the request. |
| 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
Query Parameters
It is the unique ID created by Cashfree Payments that you received in the Create DigiLocker URL API response.
It is the unique ID you created to identify the Create DigiLocker URL API request.
Response
Success response of Get DigiLocker Verification Status
It displays the details of the individual(user).
It displays the status of the API request.
It contains the information of the requested document(s) for verification.
It displays the consent of the individual(user) for document verification.
It displays the unique ID you created to identify the verification request.
It displays the unique ID created by Cashfree Payments for reference purposes.
Was this page helpful?