Verify Account API
There are people with or without Digilocker account. This API verifies the account based on the credentials entered and displays status of existance and digilocker id.
This API will check whether a digilocker account corresponding to the credentials entered exists. If exists then it will display true along with the digilockerid. We can verify existance of the account either by passing mobile number or by passing Aadhaar Number.
You are required to pass the access token received from the login call, an authorization header in the request verify account request along with Aadhaar number or phone number.
Need to pass either mobileNumber or aadhaarNumber.
Parameter Name | Required/Optional | Description |
Authorization | Required | Contains the id parameter returned from the login step |
Content-Type | Required | application/json |
task | Required | Type of task to be performed. |
essentials | Required | Essential part of the request body |
essentials.aadhaarNumber | conditionally Required | Aadhaar number |
essentials.mobileNumber | conditionally Required | Phone number |
Parameter Name | Description |
essentials | Essential part of request |
essentials.aadharNumber | Aadhaar Number of digilocker account holder. |
id | Unique user Id |
patronId | Unique PatronID |
task | Type of task to be performed - "verifyAccount" |
result | Block containing response of the API hit. |
result.registered | It describes whether digilocker account exists for entered aadhaarNumber or phoneNumber ("true/false") |
result.digilockerid | It is the digilockerid of the account |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].