SlideShare a Scribd company logo
1 of 10
Download to read offline
Requester Specification
Version 1.0
September 2015
A Digital India Initiative
National e-Governance Division.
Department of Electronics and Information Technology.
Requester Specification
1
Revision History
Version Date Author Comments
1.0 12/08/2015 Amit Savant (NeGD) Version 1.0 Released.
Requester Specification
2
Table of Contents
Revision History.......................................................................................................................................................1
Introduction...............................................................................................................................................................3
Requester Workflow..............................................................................................................................................3
Step 1: User clicks “Choose from DigiLocker” button on the client application........................3
Step 2: DigiLocker Requestor Widget pops up and prompts user to login. ................................4
Step 3: User logs in to the account and selects a file to share...........................................................4
Step 4: DigiLocker shares file with the client application and shows status message............5
Steps to Integrate Requester Workflow.........................................................................................................5
Step 1: Register as Requestor on DigiLocker...........................................................................................5
Step 2: Register Requestor Application and Domain on DigiLocker..............................................6
Step 3: Integrate DigiLocker Requestor Widget in your web application ...................................6
Integrating with Digital Locker..........................................................................................................................6
REQUESTER REGISTRATION ....................................................................................................................6
TRIGGERING DIGILOCKER FROM YOUR WEB PAGE.......................................................................7
HANDLING THE RESPONSE.......................................................................................................................8
Requester Specification
3
Digital Locker Requester Specification
Introduction
This document provides detailed specification to integrate with Digital Locker as a
Requester. The steps described in this document will be used by various departments to
access users’ documents from their Digital Locker. This document assumes that the reader
is aware of the Digital Locker application functionality.
Requester Workflow
Step 1: User clicks “Choose from DigiLocker” button on the client
application.
Requester Specification
4
Step 2: DigiLocker Requestor Widget pops up and prompts user to login.
Step 3: User logs in to the account and selects a file to share.
Requester Specification
5
Step 4: DigiLocker shares file with the client application and shows status
message.
Steps to Integrate Requester Workflow
Step 1: Register as Requestor on DigiLocker
Requester Specification
6
Step 2: Register Requestor Application and Domain on DigiLocker
Step 3: Integrate DigiLocker Requestor Widget in your web application
Integrating with Digital Locker
REQUESTER REGISTRATION
The first step in integrating with Digital Locker application is to register on Digital Locker as
a Requester. On the successful registration, the Requester application must be registered
Requester Specification
7
along with the domain of your application from which the requests to Digital Locker will be
initiated. During the registration process you create an application id (app id) for your
application. You are provided with an api key which is a secret key. The App Id and the api
key are used to authenticate the request from your application.
TRIGGERING DIGILOCKER FROM YOUR WEB PAGE
DigiLocker provides a Requestor Widget to share files from DigiLocker. This widget can be
launched with a button provided by DigiLocker Javascript library. The launches DigiLocker
application login page in a popup. A user can login to his/her DigiLocker account to select a
file that the user want to share with the requestor application. This button looks like this -
Once you register as a Requester and register your application with Digital Locker, add
following JavaScript snippet to your web page.
<script src="jquery.min.js"></script>
<script type="text/javascript"
src="https://services.digitallocker.gov.in/requester/api/1/dl.js"
id="dlshare" data-app-id="YOUR_APP_ID" data-app-hash="YOUR_APP_HASH"
time-stamp=”TIMESTAMP” data-upload-url="YOUR_UPLOAD_URL">
</script>
Please note that the DigiLocker library uses jQuery. So please download jquery.min.js file
from jQuery.com and place it on your web server. Specify the path of this file in the above
snippet in the src parameter of jQuery script.
Provide app id that was provided during the application registration process in data-app-
id parameter.
Provide SHA-256 encrypted value of your app id, app key and the timestamp values in this
sequence in data-app-hash parameter.
Provide the url of the service that uploads the file from the public url of the document
provided by Digital Locker in data-upload-url parameter. Please referto Handling The
Response section below for more details.
Provide a timestamp value in IST time zone in time-stamp parameter. This timestamp
value must not be older than 30 minutes.
To add the “Choose from DigiLocker” button to your page, add following line to your web
page where you want to add the button. Provide a unique id for every instance of the
button on your web page. The value of id can be used to identify the type of document
being shared by a user.
Requester Specification
8
<div class="share_fm_dl" id="attachment_poi"></div>
If the integration is successful, the DigiLocker Requestor Widget will be launched and you
will see the DigiLocker login page. If there is an error in the integration, the widget will
show an authentication error and an error code. Following table lists the error codes.
Code Description
203 Invalid app hash. One of app id, app key or timestamp is incorrect.
204 Invalid app id.
205 The app domain is not registered.
206 The timestamp is older than 30 minutes.
HANDLING THE RESPONSE
DigiLocker workflow returns a public url of the document selected by the user from his/her
account. The client application must retrieve the document from this url and save it at a
secure location. The client application must provide an http service to save extract and save
the file from the url. The javascript library automatically calls this http service once the
DigiLocker service returns the url. The service must comply with following specification.
DESCRIPTION
This service will be provided by the client application over https.
URL STRUCTURE
https://clientapp.gov.in/upload
METHOD POST
PARAMETERS
• user_ref (required ) DigiLocker library passes a unique reference that can be
associated with this instance of the client web page. This can be used to associate the
file with a user sharing the file.
• doc_id (required ) This is the id value of the “Choose from DigiLocker” button.
This can be associated with the type of document the user is uploading such as
proof of identity (poi) or proof of address (poa).
• doc_url (required ) This is the public url of the document shared by the user from
DigiLocker.
Requester Specification
9
FORMAT
{
'user_ref' : YOUR_USER_REF,
'doc_id' : YOUR_DOC_ID,
'doc_url' : DOCUMENT_URL
}
RETURN
The service should return ‘SUCCESS’ if the file is successfully stored or ‘FAILURE’ in
case of failure.

More Related Content

Similar to Digital Locker Requester API Specification v1 0

DevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloak
DevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloakDevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloak
DevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloakHitachi, Ltd. OSS Solution Center.
 
Azure AD B2C Webinar Series: Custom Policies Part 2 Policy Walkthrough
Azure AD B2C Webinar Series: Custom Policies Part 2 Policy WalkthroughAzure AD B2C Webinar Series: Custom Policies Part 2 Policy Walkthrough
Azure AD B2C Webinar Series: Custom Policies Part 2 Policy WalkthroughVinu Gunasekaran
 
Azure AD B2C Webinar Series: Custom Policies Part 1
Azure AD B2C Webinar Series: Custom Policies Part 1Azure AD B2C Webinar Series: Custom Policies Part 1
Azure AD B2C Webinar Series: Custom Policies Part 1Vinu Gunasekaran
 
Automatizacion de Procesos en Modelos Tabulares
Automatizacion de Procesos en Modelos TabularesAutomatizacion de Procesos en Modelos Tabulares
Automatizacion de Procesos en Modelos TabularesGaston Cruz
 
Submittal -User Manual
Submittal -User ManualSubmittal -User Manual
Submittal -User ManualNiyas Sulaiman
 
Semi_SRS_For_E_Commerce_System.pdf.pdf
Semi_SRS_For_E_Commerce_System.pdf.pdfSemi_SRS_For_E_Commerce_System.pdf.pdf
Semi_SRS_For_E_Commerce_System.pdf.pdfBdBangladesh
 
A Detailed Guide to Securing React applications with Keycloak - WalkingTree ...
A Detailed Guide to Securing React applications with Keycloak  - WalkingTree ...A Detailed Guide to Securing React applications with Keycloak  - WalkingTree ...
A Detailed Guide to Securing React applications with Keycloak - WalkingTree ...Ganesh Kumar
 
Microsoft Graph API with OutSystems Event Subscriptions
Microsoft Graph API with OutSystems Event SubscriptionsMicrosoft Graph API with OutSystems Event Subscriptions
Microsoft Graph API with OutSystems Event SubscriptionsStefan Weber
 
Microsoft AZ-204 Exam Dumps
Microsoft AZ-204 Exam DumpsMicrosoft AZ-204 Exam Dumps
Microsoft AZ-204 Exam DumpsStudy Material
 
RESTful services and OAUTH protocol in IoT
RESTful services and OAUTH protocol in IoTRESTful services and OAUTH protocol in IoT
RESTful services and OAUTH protocol in IoTYakov Fain
 
OAuth with Salesforce - Demystified
OAuth with Salesforce - DemystifiedOAuth with Salesforce - Demystified
OAuth with Salesforce - DemystifiedCalvin Noronha
 
Building Push Triggers for Logic Apps
Building Push Triggers for Logic AppsBuilding Push Triggers for Logic Apps
Building Push Triggers for Logic AppsBizTalk360
 
Microsoft identity platform and device authorization flow to use azure servic...
Microsoft identity platform and device authorization flow to use azure servic...Microsoft identity platform and device authorization flow to use azure servic...
Microsoft identity platform and device authorization flow to use azure servic...Sunil kumar Mohanty
 
Web PenTest Sample Report
Web PenTest Sample ReportWeb PenTest Sample Report
Web PenTest Sample ReportOctogence
 
What API Specifications and Tools Help Engineers to Construct a High-Security...
What API Specifications and Tools Help Engineers to Construct a High-Security...What API Specifications and Tools Help Engineers to Construct a High-Security...
What API Specifications and Tools Help Engineers to Construct a High-Security...Hitachi, Ltd. OSS Solution Center.
 
How to integrate portlet as widget in liferay to any website application
How to integrate portlet as widget in liferay to any website applicationHow to integrate portlet as widget in liferay to any website application
How to integrate portlet as widget in liferay to any website applicationAzilen Technologies Pvt. Ltd.
 
High level design document template
High level design document templateHigh level design document template
High level design document templateanosha jamshed
 
Microservice security with spring security 5.1,Oauth 2.0 and open id connect
Microservice security with spring security 5.1,Oauth 2.0 and open id connect Microservice security with spring security 5.1,Oauth 2.0 and open id connect
Microservice security with spring security 5.1,Oauth 2.0 and open id connect Nilanjan Roy
 
DIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESS
DIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESSDIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESS
DIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESSIRJET Journal
 

Similar to Digital Locker Requester API Specification v1 0 (20)

DevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloak
DevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloakDevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloak
DevConf.CZ 2020 @ Brno, Czech Republic : WebAuthn support for keycloak
 
Azure AD B2C Webinar Series: Custom Policies Part 2 Policy Walkthrough
Azure AD B2C Webinar Series: Custom Policies Part 2 Policy WalkthroughAzure AD B2C Webinar Series: Custom Policies Part 2 Policy Walkthrough
Azure AD B2C Webinar Series: Custom Policies Part 2 Policy Walkthrough
 
Azure AD B2C Webinar Series: Custom Policies Part 1
Azure AD B2C Webinar Series: Custom Policies Part 1Azure AD B2C Webinar Series: Custom Policies Part 1
Azure AD B2C Webinar Series: Custom Policies Part 1
 
Soap toolkits
Soap toolkitsSoap toolkits
Soap toolkits
 
Automatizacion de Procesos en Modelos Tabulares
Automatizacion de Procesos en Modelos TabularesAutomatizacion de Procesos en Modelos Tabulares
Automatizacion de Procesos en Modelos Tabulares
 
Submittal -User Manual
Submittal -User ManualSubmittal -User Manual
Submittal -User Manual
 
Semi_SRS_For_E_Commerce_System.pdf.pdf
Semi_SRS_For_E_Commerce_System.pdf.pdfSemi_SRS_For_E_Commerce_System.pdf.pdf
Semi_SRS_For_E_Commerce_System.pdf.pdf
 
A Detailed Guide to Securing React applications with Keycloak - WalkingTree ...
A Detailed Guide to Securing React applications with Keycloak  - WalkingTree ...A Detailed Guide to Securing React applications with Keycloak  - WalkingTree ...
A Detailed Guide to Securing React applications with Keycloak - WalkingTree ...
 
Microsoft Graph API with OutSystems Event Subscriptions
Microsoft Graph API with OutSystems Event SubscriptionsMicrosoft Graph API with OutSystems Event Subscriptions
Microsoft Graph API with OutSystems Event Subscriptions
 
Microsoft AZ-204 Exam Dumps
Microsoft AZ-204 Exam DumpsMicrosoft AZ-204 Exam Dumps
Microsoft AZ-204 Exam Dumps
 
RESTful services and OAUTH protocol in IoT
RESTful services and OAUTH protocol in IoTRESTful services and OAUTH protocol in IoT
RESTful services and OAUTH protocol in IoT
 
OAuth with Salesforce - Demystified
OAuth with Salesforce - DemystifiedOAuth with Salesforce - Demystified
OAuth with Salesforce - Demystified
 
Building Push Triggers for Logic Apps
Building Push Triggers for Logic AppsBuilding Push Triggers for Logic Apps
Building Push Triggers for Logic Apps
 
Microsoft identity platform and device authorization flow to use azure servic...
Microsoft identity platform and device authorization flow to use azure servic...Microsoft identity platform and device authorization flow to use azure servic...
Microsoft identity platform and device authorization flow to use azure servic...
 
Web PenTest Sample Report
Web PenTest Sample ReportWeb PenTest Sample Report
Web PenTest Sample Report
 
What API Specifications and Tools Help Engineers to Construct a High-Security...
What API Specifications and Tools Help Engineers to Construct a High-Security...What API Specifications and Tools Help Engineers to Construct a High-Security...
What API Specifications and Tools Help Engineers to Construct a High-Security...
 
How to integrate portlet as widget in liferay to any website application
How to integrate portlet as widget in liferay to any website applicationHow to integrate portlet as widget in liferay to any website application
How to integrate portlet as widget in liferay to any website application
 
High level design document template
High level design document templateHigh level design document template
High level design document template
 
Microservice security with spring security 5.1,Oauth 2.0 and open id connect
Microservice security with spring security 5.1,Oauth 2.0 and open id connect Microservice security with spring security 5.1,Oauth 2.0 and open id connect
Microservice security with spring security 5.1,Oauth 2.0 and open id connect
 
DIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESS
DIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESSDIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESS
DIGITAL TWIN FRAMEWORK FOR SUPPLYCHAIN PROCESS
 

More from Amit Ranjan

How stupid can we get.pdf
How stupid can we get.pdfHow stupid can we get.pdf
How stupid can we get.pdfAmit Ranjan
 
Pics - World Government Summit Dubai (#WGS2023).pptx
Pics - World Government Summit Dubai (#WGS2023).pptxPics - World Government Summit Dubai (#WGS2023).pptx
Pics - World Government Summit Dubai (#WGS2023).pptxAmit Ranjan
 
Evaluating New Age Startups: Profitability Vs Growth
Evaluating New Age Startups: Profitability Vs GrowthEvaluating New Age Startups: Profitability Vs Growth
Evaluating New Age Startups: Profitability Vs GrowthAmit Ranjan
 
The Art and Science of Building World Class Technology Products
The Art and Science of Building World Class Technology ProductsThe Art and Science of Building World Class Technology Products
The Art and Science of Building World Class Technology ProductsAmit Ranjan
 
Demo: How to get your Digital Aadhaar (eAadhaar) in DigiLocker
Demo: How to get your Digital Aadhaar (eAadhaar) in DigiLockerDemo: How to get your Digital Aadhaar (eAadhaar) in DigiLocker
Demo: How to get your Digital Aadhaar (eAadhaar) in DigiLockerAmit Ranjan
 
How Users Can Get their Digital Driving License & Vehicle Registration from D...
How Users Can Get their Digital Driving License & Vehicle Registration from D...How Users Can Get their Digital Driving License & Vehicle Registration from D...
How Users Can Get their Digital Driving License & Vehicle Registration from D...Amit Ranjan
 
Government of India Gazette Notification - The Information Technology (Preser...
Government of India Gazette Notification - The Information Technology (Preser...Government of India Gazette Notification - The Information Technology (Preser...
Government of India Gazette Notification - The Information Technology (Preser...Amit Ranjan
 
Policy on Open Application Programming Interfaces (APIs) for Government of India
Policy on Open Application Programming Interfaces (APIs) for Government of IndiaPolicy on Open Application Programming Interfaces (APIs) for Government of India
Policy on Open Application Programming Interfaces (APIs) for Government of IndiaAmit Ranjan
 
Policy on Adoption of Open Source Software for Government of India
Policy on Adoption of Open Source Software for Government of IndiaPolicy on Adoption of Open Source Software for Government of India
Policy on Adoption of Open Source Software for Government of IndiaAmit Ranjan
 
India Stack - Social Impact at Scale
India Stack - Social Impact at ScaleIndia Stack - Social Impact at Scale
India Stack - Social Impact at ScaleAmit Ranjan
 
Technical Specifications DLTS Ver 2.3
Technical Specifications DLTS Ver 2.3Technical Specifications DLTS Ver 2.3
Technical Specifications DLTS Ver 2.3Amit Ranjan
 
eSign Brochure v1.5
eSign Brochure v1.5eSign Brochure v1.5
eSign Brochure v1.5Amit Ranjan
 
Digital Locker User Manual
Digital Locker User ManualDigital Locker User Manual
Digital Locker User ManualAmit Ranjan
 
Digital Locker Intro Deck
Digital Locker Intro DeckDigital Locker Intro Deck
Digital Locker Intro DeckAmit Ranjan
 
Digital Locker Dedicated Repository API Specification v1 4
Digital Locker Dedicated Repository API Specification v1 4Digital Locker Dedicated Repository API Specification v1 4
Digital Locker Dedicated Repository API Specification v1 4Amit Ranjan
 
Bulk and Run Time Digital Signing v1.0
Bulk and Run Time Digital Signing v1.0Bulk and Run Time Digital Signing v1.0
Bulk and Run Time Digital Signing v1.0Amit Ranjan
 
Policy On Collaborative Application Development by Opening the Source Code of...
Policy On Collaborative Application Development by Opening the Source Code of...Policy On Collaborative Application Development by Opening the Source Code of...
Policy On Collaborative Application Development by Opening the Source Code of...Amit Ranjan
 

More from Amit Ranjan (20)

How stupid can we get.pdf
How stupid can we get.pdfHow stupid can we get.pdf
How stupid can we get.pdf
 
doc sample.docx
doc sample.docxdoc sample.docx
doc sample.docx
 
designing.ppt
designing.pptdesigning.ppt
designing.ppt
 
turef67wea.pptx
turef67wea.pptxturef67wea.pptx
turef67wea.pptx
 
Pics - World Government Summit Dubai (#WGS2023).pptx
Pics - World Government Summit Dubai (#WGS2023).pptxPics - World Government Summit Dubai (#WGS2023).pptx
Pics - World Government Summit Dubai (#WGS2023).pptx
 
Evaluating New Age Startups: Profitability Vs Growth
Evaluating New Age Startups: Profitability Vs GrowthEvaluating New Age Startups: Profitability Vs Growth
Evaluating New Age Startups: Profitability Vs Growth
 
The Art and Science of Building World Class Technology Products
The Art and Science of Building World Class Technology ProductsThe Art and Science of Building World Class Technology Products
The Art and Science of Building World Class Technology Products
 
Demo: How to get your Digital Aadhaar (eAadhaar) in DigiLocker
Demo: How to get your Digital Aadhaar (eAadhaar) in DigiLockerDemo: How to get your Digital Aadhaar (eAadhaar) in DigiLocker
Demo: How to get your Digital Aadhaar (eAadhaar) in DigiLocker
 
How Users Can Get their Digital Driving License & Vehicle Registration from D...
How Users Can Get their Digital Driving License & Vehicle Registration from D...How Users Can Get their Digital Driving License & Vehicle Registration from D...
How Users Can Get their Digital Driving License & Vehicle Registration from D...
 
Government of India Gazette Notification - The Information Technology (Preser...
Government of India Gazette Notification - The Information Technology (Preser...Government of India Gazette Notification - The Information Technology (Preser...
Government of India Gazette Notification - The Information Technology (Preser...
 
Policy on Open Application Programming Interfaces (APIs) for Government of India
Policy on Open Application Programming Interfaces (APIs) for Government of IndiaPolicy on Open Application Programming Interfaces (APIs) for Government of India
Policy on Open Application Programming Interfaces (APIs) for Government of India
 
Policy on Adoption of Open Source Software for Government of India
Policy on Adoption of Open Source Software for Government of IndiaPolicy on Adoption of Open Source Software for Government of India
Policy on Adoption of Open Source Software for Government of India
 
India Stack - Social Impact at Scale
India Stack - Social Impact at ScaleIndia Stack - Social Impact at Scale
India Stack - Social Impact at Scale
 
Technical Specifications DLTS Ver 2.3
Technical Specifications DLTS Ver 2.3Technical Specifications DLTS Ver 2.3
Technical Specifications DLTS Ver 2.3
 
eSign Brochure v1.5
eSign Brochure v1.5eSign Brochure v1.5
eSign Brochure v1.5
 
Digital Locker User Manual
Digital Locker User ManualDigital Locker User Manual
Digital Locker User Manual
 
Digital Locker Intro Deck
Digital Locker Intro DeckDigital Locker Intro Deck
Digital Locker Intro Deck
 
Digital Locker Dedicated Repository API Specification v1 4
Digital Locker Dedicated Repository API Specification v1 4Digital Locker Dedicated Repository API Specification v1 4
Digital Locker Dedicated Repository API Specification v1 4
 
Bulk and Run Time Digital Signing v1.0
Bulk and Run Time Digital Signing v1.0Bulk and Run Time Digital Signing v1.0
Bulk and Run Time Digital Signing v1.0
 
Policy On Collaborative Application Development by Opening the Source Code of...
Policy On Collaborative Application Development by Opening the Source Code of...Policy On Collaborative Application Development by Opening the Source Code of...
Policy On Collaborative Application Development by Opening the Source Code of...
 

Recently uploaded

Children who live with Grandparents are really lucky
Children who live with Grandparents are really luckyChildren who live with Grandparents are really lucky
Children who live with Grandparents are really luckySERUDS INDIA
 
Item # 5&6 - 218 Canyon Drive replat prop.
Item # 5&6 - 218 Canyon Drive replat prop.Item # 5&6 - 218 Canyon Drive replat prop.
Item # 5&6 - 218 Canyon Drive replat prop.ahcitycouncil
 
My Burning Issue: "War in Ukraine" Cycle 54
My Burning Issue: "War in Ukraine" Cycle 54My Burning Issue: "War in Ukraine" Cycle 54
My Burning Issue: "War in Ukraine" Cycle 54mmazurak
 
National Women's Month Celebration for PENRO Quezon
National Women's Month Celebration for PENRO QuezonNational Women's Month Celebration for PENRO Quezon
National Women's Month Celebration for PENRO QuezonAryaCapale
 
PPT Item # 5-6 218 Canyon Drive replat prop.
PPT Item # 5-6 218 Canyon Drive replat prop.PPT Item # 5-6 218 Canyon Drive replat prop.
PPT Item # 5-6 218 Canyon Drive replat prop.ahcitycouncil
 
Leveraging Water for Peace - World Water Day 2024
Leveraging Water for Peace - World Water Day 2024Leveraging Water for Peace - World Water Day 2024
Leveraging Water for Peace - World Water Day 2024Christina Parmionova
 
Item # 1a - March 18, 2024 Special CCM Minutes
Item # 1a - March 18, 2024 Special CCM MinutesItem # 1a - March 18, 2024 Special CCM Minutes
Item # 1a - March 18, 2024 Special CCM Minutesahcitycouncil
 
The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...
The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...
The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...Congressional Budget Office
 
O Conselho Estadual de Cultura e o Incentivo à Cultura no RS: relato de expe...
O Conselho Estadual de Cultura e o Incentivo à Cultura no RS:  relato de expe...O Conselho Estadual de Cultura e o Incentivo à Cultura no RS:  relato de expe...
O Conselho Estadual de Cultura e o Incentivo à Cultura no RS: relato de expe...Alvaro Santi
 
CBO’s Work on Health Care and a Call for New Research
CBO’s Work on Health Care and a Call for New ResearchCBO’s Work on Health Care and a Call for New Research
CBO’s Work on Health Care and a Call for New ResearchCongressional Budget Office
 
Yes!? We can end TB - World Tuberculosis Day 2024.
Yes!? We can end TB - World Tuberculosis Day 2024.Yes!? We can end TB - World Tuberculosis Day 2024.
Yes!? We can end TB - World Tuberculosis Day 2024.Christina Parmionova
 
War in Ukraine and problematics of the Ukrainian refugees in USA
War in Ukraine and problematics of the Ukrainian refugees in USAWar in Ukraine and problematics of the Ukrainian refugees in USA
War in Ukraine and problematics of the Ukrainian refugees in USAival6
 
2024: The FAR, Federal Acquisition Regulations - Part 16
2024: The FAR, Federal Acquisition Regulations - Part 162024: The FAR, Federal Acquisition Regulations - Part 16
2024: The FAR, Federal Acquisition Regulations - Part 16JSchaus & Associates
 
Water and peace go hand-in hand. World Water Day 2024
Water and peace go hand-in hand. World Water Day 2024Water and peace go hand-in hand. World Water Day 2024
Water and peace go hand-in hand. World Water Day 2024Christina Parmionova
 
SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...
SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...
SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...JSchaus & Associates
 
india sanitation coalition Swachata Abhiyan ​.pdf
india sanitation coalition Swachata Abhiyan ​.pdfindia sanitation coalition Swachata Abhiyan ​.pdf
india sanitation coalition Swachata Abhiyan ​.pdfcoalitionindiasanita
 
Item # 4 - Appointment of new PW Director
Item # 4 - Appointment of new PW DirectorItem # 4 - Appointment of new PW Director
Item # 4 - Appointment of new PW Directorahcitycouncil
 
OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...
OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...
OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...OECDregions
 
What Teenagers Have to Say about the Grandparents
What Teenagers Have to Say about the GrandparentsWhat Teenagers Have to Say about the Grandparents
What Teenagers Have to Say about the GrandparentsSERUDS INDIA
 

Recently uploaded (20)

Children who live with Grandparents are really lucky
Children who live with Grandparents are really luckyChildren who live with Grandparents are really lucky
Children who live with Grandparents are really lucky
 
Item # 5&6 - 218 Canyon Drive replat prop.
Item # 5&6 - 218 Canyon Drive replat prop.Item # 5&6 - 218 Canyon Drive replat prop.
Item # 5&6 - 218 Canyon Drive replat prop.
 
My Burning Issue: "War in Ukraine" Cycle 54
My Burning Issue: "War in Ukraine" Cycle 54My Burning Issue: "War in Ukraine" Cycle 54
My Burning Issue: "War in Ukraine" Cycle 54
 
National Women's Month Celebration for PENRO Quezon
National Women's Month Celebration for PENRO QuezonNational Women's Month Celebration for PENRO Quezon
National Women's Month Celebration for PENRO Quezon
 
PPT Item # 5-6 218 Canyon Drive replat prop.
PPT Item # 5-6 218 Canyon Drive replat prop.PPT Item # 5-6 218 Canyon Drive replat prop.
PPT Item # 5-6 218 Canyon Drive replat prop.
 
Leveraging Water for Peace - World Water Day 2024
Leveraging Water for Peace - World Water Day 2024Leveraging Water for Peace - World Water Day 2024
Leveraging Water for Peace - World Water Day 2024
 
Item # 1a - March 18, 2024 Special CCM Minutes
Item # 1a - March 18, 2024 Special CCM MinutesItem # 1a - March 18, 2024 Special CCM Minutes
Item # 1a - March 18, 2024 Special CCM Minutes
 
The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...
The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...
The Federal Perspective on Coverage of Medications to Treat Obesity: Consider...
 
O Conselho Estadual de Cultura e o Incentivo à Cultura no RS: relato de expe...
O Conselho Estadual de Cultura e o Incentivo à Cultura no RS:  relato de expe...O Conselho Estadual de Cultura e o Incentivo à Cultura no RS:  relato de expe...
O Conselho Estadual de Cultura e o Incentivo à Cultura no RS: relato de expe...
 
CBO’s Work on Health Care and a Call for New Research
CBO’s Work on Health Care and a Call for New ResearchCBO’s Work on Health Care and a Call for New Research
CBO’s Work on Health Care and a Call for New Research
 
Yes!? We can end TB - World Tuberculosis Day 2024.
Yes!? We can end TB - World Tuberculosis Day 2024.Yes!? We can end TB - World Tuberculosis Day 2024.
Yes!? We can end TB - World Tuberculosis Day 2024.
 
War in Ukraine and problematics of the Ukrainian refugees in USA
War in Ukraine and problematics of the Ukrainian refugees in USAWar in Ukraine and problematics of the Ukrainian refugees in USA
War in Ukraine and problematics of the Ukrainian refugees in USA
 
2024: The FAR, Federal Acquisition Regulations - Part 16
2024: The FAR, Federal Acquisition Regulations - Part 162024: The FAR, Federal Acquisition Regulations - Part 16
2024: The FAR, Federal Acquisition Regulations - Part 16
 
Water and peace go hand-in hand. World Water Day 2024
Water and peace go hand-in hand. World Water Day 2024Water and peace go hand-in hand. World Water Day 2024
Water and peace go hand-in hand. World Water Day 2024
 
SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...
SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...
SPONSORED CONTENT - MyGovWatch - RFP Cliches Debunked: What Government Buyers...
 
india sanitation coalition Swachata Abhiyan ​.pdf
india sanitation coalition Swachata Abhiyan ​.pdfindia sanitation coalition Swachata Abhiyan ​.pdf
india sanitation coalition Swachata Abhiyan ​.pdf
 
How to Save a Place: Become an Advocate.
How to Save a Place: Become an Advocate.How to Save a Place: Become an Advocate.
How to Save a Place: Become an Advocate.
 
Item # 4 - Appointment of new PW Director
Item # 4 - Appointment of new PW DirectorItem # 4 - Appointment of new PW Director
Item # 4 - Appointment of new PW Director
 
OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...
OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...
OECD Webinar - ESG to deliver well-being in resource-rich regions: the role o...
 
What Teenagers Have to Say about the Grandparents
What Teenagers Have to Say about the GrandparentsWhat Teenagers Have to Say about the Grandparents
What Teenagers Have to Say about the Grandparents
 

Digital Locker Requester API Specification v1 0

  • 1. Requester Specification Version 1.0 September 2015 A Digital India Initiative National e-Governance Division. Department of Electronics and Information Technology.
  • 2. Requester Specification 1 Revision History Version Date Author Comments 1.0 12/08/2015 Amit Savant (NeGD) Version 1.0 Released.
  • 3. Requester Specification 2 Table of Contents Revision History.......................................................................................................................................................1 Introduction...............................................................................................................................................................3 Requester Workflow..............................................................................................................................................3 Step 1: User clicks “Choose from DigiLocker” button on the client application........................3 Step 2: DigiLocker Requestor Widget pops up and prompts user to login. ................................4 Step 3: User logs in to the account and selects a file to share...........................................................4 Step 4: DigiLocker shares file with the client application and shows status message............5 Steps to Integrate Requester Workflow.........................................................................................................5 Step 1: Register as Requestor on DigiLocker...........................................................................................5 Step 2: Register Requestor Application and Domain on DigiLocker..............................................6 Step 3: Integrate DigiLocker Requestor Widget in your web application ...................................6 Integrating with Digital Locker..........................................................................................................................6 REQUESTER REGISTRATION ....................................................................................................................6 TRIGGERING DIGILOCKER FROM YOUR WEB PAGE.......................................................................7 HANDLING THE RESPONSE.......................................................................................................................8
  • 4. Requester Specification 3 Digital Locker Requester Specification Introduction This document provides detailed specification to integrate with Digital Locker as a Requester. The steps described in this document will be used by various departments to access users’ documents from their Digital Locker. This document assumes that the reader is aware of the Digital Locker application functionality. Requester Workflow Step 1: User clicks “Choose from DigiLocker” button on the client application.
  • 5. Requester Specification 4 Step 2: DigiLocker Requestor Widget pops up and prompts user to login. Step 3: User logs in to the account and selects a file to share.
  • 6. Requester Specification 5 Step 4: DigiLocker shares file with the client application and shows status message. Steps to Integrate Requester Workflow Step 1: Register as Requestor on DigiLocker
  • 7. Requester Specification 6 Step 2: Register Requestor Application and Domain on DigiLocker Step 3: Integrate DigiLocker Requestor Widget in your web application Integrating with Digital Locker REQUESTER REGISTRATION The first step in integrating with Digital Locker application is to register on Digital Locker as a Requester. On the successful registration, the Requester application must be registered
  • 8. Requester Specification 7 along with the domain of your application from which the requests to Digital Locker will be initiated. During the registration process you create an application id (app id) for your application. You are provided with an api key which is a secret key. The App Id and the api key are used to authenticate the request from your application. TRIGGERING DIGILOCKER FROM YOUR WEB PAGE DigiLocker provides a Requestor Widget to share files from DigiLocker. This widget can be launched with a button provided by DigiLocker Javascript library. The launches DigiLocker application login page in a popup. A user can login to his/her DigiLocker account to select a file that the user want to share with the requestor application. This button looks like this - Once you register as a Requester and register your application with Digital Locker, add following JavaScript snippet to your web page. <script src="jquery.min.js"></script> <script type="text/javascript" src="https://services.digitallocker.gov.in/requester/api/1/dl.js" id="dlshare" data-app-id="YOUR_APP_ID" data-app-hash="YOUR_APP_HASH" time-stamp=”TIMESTAMP” data-upload-url="YOUR_UPLOAD_URL"> </script> Please note that the DigiLocker library uses jQuery. So please download jquery.min.js file from jQuery.com and place it on your web server. Specify the path of this file in the above snippet in the src parameter of jQuery script. Provide app id that was provided during the application registration process in data-app- id parameter. Provide SHA-256 encrypted value of your app id, app key and the timestamp values in this sequence in data-app-hash parameter. Provide the url of the service that uploads the file from the public url of the document provided by Digital Locker in data-upload-url parameter. Please referto Handling The Response section below for more details. Provide a timestamp value in IST time zone in time-stamp parameter. This timestamp value must not be older than 30 minutes. To add the “Choose from DigiLocker” button to your page, add following line to your web page where you want to add the button. Provide a unique id for every instance of the button on your web page. The value of id can be used to identify the type of document being shared by a user.
  • 9. Requester Specification 8 <div class="share_fm_dl" id="attachment_poi"></div> If the integration is successful, the DigiLocker Requestor Widget will be launched and you will see the DigiLocker login page. If there is an error in the integration, the widget will show an authentication error and an error code. Following table lists the error codes. Code Description 203 Invalid app hash. One of app id, app key or timestamp is incorrect. 204 Invalid app id. 205 The app domain is not registered. 206 The timestamp is older than 30 minutes. HANDLING THE RESPONSE DigiLocker workflow returns a public url of the document selected by the user from his/her account. The client application must retrieve the document from this url and save it at a secure location. The client application must provide an http service to save extract and save the file from the url. The javascript library automatically calls this http service once the DigiLocker service returns the url. The service must comply with following specification. DESCRIPTION This service will be provided by the client application over https. URL STRUCTURE https://clientapp.gov.in/upload METHOD POST PARAMETERS • user_ref (required ) DigiLocker library passes a unique reference that can be associated with this instance of the client web page. This can be used to associate the file with a user sharing the file. • doc_id (required ) This is the id value of the “Choose from DigiLocker” button. This can be associated with the type of document the user is uploading such as proof of identity (poi) or proof of address (poa). • doc_url (required ) This is the public url of the document shared by the user from DigiLocker.
  • 10. Requester Specification 9 FORMAT { 'user_ref' : YOUR_USER_REF, 'doc_id' : YOUR_DOC_ID, 'doc_url' : DOCUMENT_URL } RETURN The service should return ‘SUCCESS’ if the file is successfully stored or ‘FAILURE’ in case of failure.