Digilocker Uniquery API (New)
Introduction
Now, fetch IDs from Digilocker in just one API request.
By merging the Get Details and Get Files APIs, we've simplified the process, eliminating the need for Requesters to integrate multiple APIs. Once the ID owner gives consent via the URL the requester shares, this API retrieves approved IDs, including Aadhar, PAN, DL, and more, asynchronously.
Once ready, a callback with the URLs of approved files is sent directly to the requester's configured callback URL.
Say goodbye to complexity and hello to efficiency with the Digilocker Uniquery API. Simplify your ID fetching journey today!
Note: The callback URL will be configured in the Signzy gateway during onboarding, so Requesters don't have to pass it in each API request.
API details
Endpoint
POST https://api.signzy.app/api/v3/digilocker/docFetchConsentPOST https://api-preproduction.signzy.app/api/v3/digilocker/docFetchConsentRequest headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Request body parameter
Parameter | Data Type | Description | Required |
|---|---|---|---|
signup | Boolean | Indicates if the signup process is enabled or not. “true” if signup is enabled. | Optional |
redirectUrl | String | URL to which your end customer will be redirected after providing authorization. | Optional |
redirectTime | Integer | Time (in seconds) after which the user will be redirected. | Optional |
successRedirectUrl | String | URL to which the user will be redirected upon successful authorization. | Optional |
successRedirectTime | Integer | Time (in seconds) after which the user will be redirected post-authorization. By default, it is 10 seconds. | Optional |
failureRedirectUrl | String | URL to which the user will be redirected if not authorized. | Optional |
failureRedirectTime | Integer | Time (in seconds) after which the user will be redirected if not authorized. By default, it is 10 seconds. | Optional |
logoVisible | String | Indicates if a logo is to be displayed or not. "true" if you want the logo to be displayed. | Optional |
logo | String | URL of the logo to be displayed if logoVisible is "true". | Optional |
supportEmailVisible | String | Indicates if a support URL is to be displayed or not. | Optional |
supportEmail | String | Email of the support page or support contact, to be displayed if supportEmailVisible is "true". | Optional |
docType | Array of strings | Documents that you want to take consent from the end customer. By default, the value of this field would be ["PANCR", "ADHAR", "DRVLC"]. If you have a use-case where you want consent for some other doc type then a mapping would need to be done on Digilocker's end. Reach out to the Signzy support team to facilitate the process for you. | Optional |
purpose | String | Defines the purpose for which the end customer is giving consent. The possible input values are: "kyc" "verification" "compliance" "availing_services" "educational". | Optional |
getScope | Boolean | "true" if you want to check what access has been given by your end customers else "false". If set as "true" then the scope information will be pushed on the callback URL. | Optional |
consentValidTill | Integer | The validity period of the consent. Timestamp value in seconds using the UNIX(or POSIX) format and the IST time zone. The Digilocker team has not enabled the refresh token workflow, hence the requestId can be used only for 1 hour after the customer provides the consent. | Optional |
showLoaderState | Boolean | Indicates if the end customer will be able to see the loader at the end of the journey. (Only when redirectUrl is provided). | Optional |
internalId | String | ID to track your callback. | Optional |
companyName | String | Company name to display in the title bar at the end of the journey. | Optional |
favIcon | String | URL of the fav icon to display in the title bar at the end of the journey. | Optional |
persistPassword | String | String for Securing Files Retrieved via Digilocker APIs with Password Protection. [Read more] | Optional |
pinlessAuthentication | Boolean | Use this argument to enable a seamless, PIN-free login experience in the Digilocker mobile flow, available exclusively through the Wayne domain. | Optional |
{
"signup": true,
"redirectUrl": "https://www.signzy.com/",
"redirectTime": "1",
"successRedirectUrl": "https://www.signzy.com/",
"successRedirectTime": "5",
"failureRedirectUrl": "https://www.signzy.com/",
"failureRedirectTime": "5",
"logoVisible": "true",
"logo": "https://rise.barclays/content/dam/thinkrise-com/images/rise-stories/Signzy-16_9.full.high_quality.jpg",
"supportEmailVisible": "true",
"supportEmail": "[email protected]",
"docType": [
"PANCR",
"ADHAR"
],
"purpose": "kyc",
"getScope": true,
"consentValidTill": 1729141682,
"showLoaderState":true,
"internalId":"<Internal ID>",
"companyName":"Signzy",
"favIcon":"https://rise.barclays/content/dam/thinkrise-com/images/rise-stories/Signzy-16_9.full.high_quality.jpg",
"persistPassword": ""
}Code samples
curl --location 'https://api-preproduction.signzy.app/api/v3/digilocker/docFetchConsent' \
--header 'Authorization: <Your access token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"signup": true,
"redirectUrl": "https://www.signzy.com/",
"redirectTime": "1",
"successRedirectUrl": "https://www.signzy.com/",
"successRedirectTime": "5",
"failureRedirectUrl": "https://www.signzy.com/",
"failureRedirectTime": "5",
"logoVisible": "true",
"logo": "",
"supportEmailVisible": "true",
"supportEmail": "[email protected]",
"docType": [
"PANCR",
"ADHAR"
],
"purpose": "kyc",
"getScope": true,
"consentValidTill": 1729141682,
"showLoaderState":true,
"internalId":"<Internal ID>",
"companyName":"Signzy",
"favIcon":""
}'Response body parameters
Parameter | Data Type | Description |
|---|---|---|
result | Object | Contains the result of the task being performed. |
result.url | String | The URL to complete the authentication. |
result.requestId | String | Unique ID allocated after the authorization in digilocker iframe. |
// If Authorization token is not passed
{
"message": "No API key found in request"
}
// If Authorization token is invalid
{
"message": "Invalid authentication credentials"
}Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!