Create URL API
Introduction
Firstly an URL will be created where the user will provide their Digilocker credentials on Digilocker iframe, and give consent that Signzy can download the file on the client's behalf.
How to call the API
Signzy provides a Digilocker iframe where the user enters the Digilocker credentials and once it is verified by a valid OTP sent to the registered mobile number user gets an access token from the login API call, now user can send further calls to different endpoints by passing the access token in Authorization header or in the access token query (GET) parameter.
User mobile number must be registered to his/her Aadhaar, to extract data using this API.
Steps to get URL
- Open Digilocker iFrame
- Enter Aadhaar number
- Verify with the OTP sent on the registered mobile number
- Load Digilocker Url
- Open the URL in a web browser.
- In the case of a web app product, load the URL in the iframe
- In the case of mobile APP, load the URL in the web view and you need to enable local storage in our APP.
- Once URL is open, you have to enter your Digilocker credentials and give consent that Signzy can download the file on the client behalf
- Once Signzy is authorized, a thank you page will be shown
On Successful validation user will receive this message
Once access is granted, RequestID can be then used further to call API's like, Get Aadhaar details, Get details of issued docs etc.
Sample CURL request
curl --location --request POST '<https://preproduction.signzy.tech/api/v2/patrons/<Your> Patron ID>/digilockers' \
--header 'Authorization: AUTH' \
--header 'Content-Type: application/json' \
--header 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \
--data-raw '{
"task": "url"
}'Input Parameters
Parameter Name | Description |
|---|---|
Authorization | Contains the id parameter returned from the login step |
Content-Type | application/json |
Task | Type of Tasks to be performed in Signzy System, eg: URL , GetData |
Sample API Response
{
"id": " ",
"patronId": " ",
"task": "url",
"result": {
"url": "<https://api.digitallocker.gov.in/public/oauth2/1/authorize?client_id=7E5773CXXXX_flow&redirect_uri=https%3A%2F%2Fdigilocker-preproduction.signzy.tech%2Fdigilocker-auth-complete&response_type=code&state=614aa21583e52667a11cXXXX",>
"requestId": "614aa1d183e52667a11cXXXX"
}
}Output Parameters
Parameter Name | Description |
|---|---|
id | Unique ID of the request. |
patronId | Patron ID of the user from the login call |
task | Task should be url |
result.url | URL needs to be opened in a web browser to give signzy its access. |
result.requestId | Request ID that will be used in other APIs |
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].