SlideShare a Scribd company logo
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

What's hot

Test your microservices with REST-Assured
Test your microservices with REST-AssuredTest your microservices with REST-Assured
Test your microservices with REST-Assured
Michel Schudel
 
Token, token... From SAML to OIDC
Token, token... From SAML to OIDCToken, token... From SAML to OIDC
Token, token... From SAML to OIDC
Shiu-Fun Poon
 
Fido Technical Overview
Fido Technical OverviewFido Technical Overview
Fido Technical Overview
FIDO Alliance
 
OAuth2 + API Security
OAuth2 + API SecurityOAuth2 + API Security
OAuth2 + API Security
Amila Paranawithana
 
OAuth 2.0 and OpenId Connect
OAuth 2.0 and OpenId ConnectOAuth 2.0 and OpenId Connect
OAuth 2.0 and OpenId Connect
Saran Doraiswamy
 
What is REST API? REST API Concepts and Examples | Edureka
What is REST API? REST API Concepts and Examples | EdurekaWhat is REST API? REST API Concepts and Examples | Edureka
What is REST API? REST API Concepts and Examples | Edureka
Edureka!
 
IBM APIc API security protection mechanism
IBM APIc API security protection mechanismIBM APIc API security protection mechanism
IBM APIc API security protection mechanism
Shiu-Fun Poon
 
Developer Tutorial: WebAuthn for Web & FIDO2 for Android
Developer Tutorial: WebAuthn for Web & FIDO2 for AndroidDeveloper Tutorial: WebAuthn for Web & FIDO2 for Android
Developer Tutorial: WebAuthn for Web & FIDO2 for Android
FIDO Alliance
 
IdM and AC
IdM and ACIdM and AC
Angular
AngularAngular
API Security : Patterns and Practices
API Security : Patterns and PracticesAPI Security : Patterns and Practices
API Security : Patterns and Practices
Prabath Siriwardena
 
Checkmarx meetup API Security - API Security top 10 - Erez Yalon
Checkmarx meetup API Security -  API Security top 10 - Erez YalonCheckmarx meetup API Security -  API Security top 10 - Erez Yalon
Checkmarx meetup API Security - API Security top 10 - Erez Yalon
Adar Weidman
 
Webauthn Tutorial
Webauthn TutorialWebauthn Tutorial
Webauthn Tutorial
FIDO Alliance
 
API Management in Digital Transformation
API Management in Digital TransformationAPI Management in Digital Transformation
API Management in Digital Transformation
Aditya Thatte
 
REST API and CRUD
REST API and CRUDREST API and CRUD
REST API and CRUD
Prem Sanil
 
Introduction to Microservices
Introduction to MicroservicesIntroduction to Microservices
Introduction to Microservices
Amazon Web Services
 
OAuth2 - Introduction
OAuth2 - IntroductionOAuth2 - Introduction
OAuth2 - Introduction
Knoldus Inc.
 
Introduction to Spring Framework
Introduction to Spring FrameworkIntroduction to Spring Framework
Introduction to Spring Framework
Serhat Can
 
REST API Design & Development
REST API Design & DevelopmentREST API Design & Development
REST API Design & Development
Ashok Pundit
 
IBM: Hey FIDO, Meet Passkey!.pptx
IBM: Hey FIDO, Meet Passkey!.pptxIBM: Hey FIDO, Meet Passkey!.pptx
IBM: Hey FIDO, Meet Passkey!.pptx
FIDO Alliance
 

What's hot (20)

Test your microservices with REST-Assured
Test your microservices with REST-AssuredTest your microservices with REST-Assured
Test your microservices with REST-Assured
 
Token, token... From SAML to OIDC
Token, token... From SAML to OIDCToken, token... From SAML to OIDC
Token, token... From SAML to OIDC
 
Fido Technical Overview
Fido Technical OverviewFido Technical Overview
Fido Technical Overview
 
OAuth2 + API Security
OAuth2 + API SecurityOAuth2 + API Security
OAuth2 + API Security
 
OAuth 2.0 and OpenId Connect
OAuth 2.0 and OpenId ConnectOAuth 2.0 and OpenId Connect
OAuth 2.0 and OpenId Connect
 
What is REST API? REST API Concepts and Examples | Edureka
What is REST API? REST API Concepts and Examples | EdurekaWhat is REST API? REST API Concepts and Examples | Edureka
What is REST API? REST API Concepts and Examples | Edureka
 
IBM APIc API security protection mechanism
IBM APIc API security protection mechanismIBM APIc API security protection mechanism
IBM APIc API security protection mechanism
 
Developer Tutorial: WebAuthn for Web & FIDO2 for Android
Developer Tutorial: WebAuthn for Web & FIDO2 for AndroidDeveloper Tutorial: WebAuthn for Web & FIDO2 for Android
Developer Tutorial: WebAuthn for Web & FIDO2 for Android
 
IdM and AC
IdM and ACIdM and AC
IdM and AC
 
Angular
AngularAngular
Angular
 
API Security : Patterns and Practices
API Security : Patterns and PracticesAPI Security : Patterns and Practices
API Security : Patterns and Practices
 
Checkmarx meetup API Security - API Security top 10 - Erez Yalon
Checkmarx meetup API Security -  API Security top 10 - Erez YalonCheckmarx meetup API Security -  API Security top 10 - Erez Yalon
Checkmarx meetup API Security - API Security top 10 - Erez Yalon
 
Webauthn Tutorial
Webauthn TutorialWebauthn Tutorial
Webauthn Tutorial
 
API Management in Digital Transformation
API Management in Digital TransformationAPI Management in Digital Transformation
API Management in Digital Transformation
 
REST API and CRUD
REST API and CRUDREST API and CRUD
REST API and CRUD
 
Introduction to Microservices
Introduction to MicroservicesIntroduction to Microservices
Introduction to Microservices
 
OAuth2 - Introduction
OAuth2 - IntroductionOAuth2 - Introduction
OAuth2 - Introduction
 
Introduction to Spring Framework
Introduction to Spring FrameworkIntroduction to Spring Framework
Introduction to Spring Framework
 
REST API Design & Development
REST API Design & DevelopmentREST API Design & Development
REST API Design & Development
 
IBM: Hey FIDO, Meet Passkey!.pptx
IBM: Hey FIDO, Meet Passkey!.pptxIBM: Hey FIDO, Meet Passkey!.pptx
IBM: Hey FIDO, Meet Passkey!.pptx
 

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 keycloak
Hitachi, 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 Walkthrough
Vinu 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 1
Vinu Gunasekaran
 
Soap toolkits
Soap toolkitsSoap toolkits
Soap toolkits
Aravindharamanan S
 
Automatizacion de Procesos en Modelos Tabulares
Automatizacion de Procesos en Modelos TabularesAutomatizacion de Procesos en Modelos Tabulares
Automatizacion de Procesos en Modelos Tabulares
Gaston Cruz
 
Submittal -User Manual
Submittal -User ManualSubmittal -User Manual
Submittal -User Manual
Niyas Sulaiman
 
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 Subscriptions
Stefan Weber
 
Microsoft AZ-204 Exam Dumps
Microsoft AZ-204 Exam DumpsMicrosoft AZ-204 Exam Dumps
Microsoft AZ-204 Exam Dumps
Study 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 IoT
Yakov Fain
 
OAuth with Salesforce - Demystified
OAuth with Salesforce - DemystifiedOAuth with Salesforce - Demystified
OAuth with Salesforce - Demystified
Calvin Noronha
 
Building Push Triggers for Logic Apps
Building Push Triggers for Logic AppsBuilding Push Triggers for Logic Apps
Building Push Triggers for Logic Apps
BizTalk360
 
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 Report
Octogence
 
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 application
Azilen Technologies Pvt. Ltd.
 
High level design document template
High level design document templateHigh level design document template
High level design document template
anosha 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 PROCESS
IRJET Journal
 
User id installation and configuration
User id installation and configurationUser id installation and configuration
User id installation and configuration
Alberto Rivai
 

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
 
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
 
User id installation and configuration
User id installation and configurationUser id installation and configuration
User id installation and configuration
 

More from DigiLocker

How ICSE or ISC Students can get their Digital Marksheets from DigiLocker
How ICSE or ISC Students can get their Digital Marksheets from DigiLocker How ICSE or ISC Students can get their Digital Marksheets from DigiLocker
How ICSE or ISC Students can get their Digital Marksheets from DigiLocker
DigiLocker
 
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
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...
DigiLocker
 
Transport
TransportTransport
Transport
DigiLocker
 
How Educational Institutions Can Provide Digital Mark Sheets To Students Us...
How Educational Institutions Can  Provide Digital Mark Sheets To Students  Us...How Educational Institutions Can  Provide Digital Mark Sheets To Students  Us...
How Educational Institutions Can Provide Digital Mark Sheets To Students Us...
DigiLocker
 
How CBSE Students can get their Digital Marksheets from DigiLocker
How CBSE Students can get their Digital Marksheets from DigiLocker How CBSE Students can get their Digital Marksheets from DigiLocker
How CBSE Students can get their Digital Marksheets from DigiLocker
DigiLocker
 
Technical Specifications DLTS ver 2.3
Technical Specifications DLTS ver 2.3Technical Specifications DLTS ver 2.3
Technical Specifications DLTS ver 2.3
DigiLocker
 
eSign Brochure1.5
eSign Brochure1.5eSign Brochure1.5
eSign Brochure1.5
DigiLocker
 
Digital Locker User Manual
Digital Locker User ManualDigital Locker User Manual
Digital Locker User Manual
DigiLocker
 
Digital Locker Intro
Digital Locker Intro Digital Locker Intro
Digital Locker Intro
DigiLocker
 
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
DigiLocker
 

More from DigiLocker (11)

How ICSE or ISC Students can get their Digital Marksheets from DigiLocker
How ICSE or ISC Students can get their Digital Marksheets from DigiLocker How ICSE or ISC Students can get their Digital Marksheets from DigiLocker
How ICSE or ISC Students can get their Digital Marksheets from DigiLocker
 
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...
 
Transport
TransportTransport
Transport
 
How Educational Institutions Can Provide Digital Mark Sheets To Students Us...
How Educational Institutions Can  Provide Digital Mark Sheets To Students  Us...How Educational Institutions Can  Provide Digital Mark Sheets To Students  Us...
How Educational Institutions Can Provide Digital Mark Sheets To Students Us...
 
How CBSE Students can get their Digital Marksheets from DigiLocker
How CBSE Students can get their Digital Marksheets from DigiLocker How CBSE Students can get their Digital Marksheets from DigiLocker
How CBSE Students can get their Digital Marksheets from DigiLocker
 
Technical Specifications DLTS ver 2.3
Technical Specifications DLTS ver 2.3Technical Specifications DLTS ver 2.3
Technical Specifications DLTS ver 2.3
 
eSign Brochure1.5
eSign Brochure1.5eSign Brochure1.5
eSign Brochure1.5
 
Digital Locker User Manual
Digital Locker User ManualDigital Locker User Manual
Digital Locker User Manual
 
Digital Locker Intro
Digital Locker Intro Digital Locker Intro
Digital Locker Intro
 
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
 

Recently uploaded

Spending in the 340B Drug Pricing Program, 2010 to 2021
Spending in the 340B Drug Pricing Program, 2010 to 2021Spending in the 340B Drug Pricing Program, 2010 to 2021
Spending in the 340B Drug Pricing Program, 2010 to 2021
Congressional Budget Office
 
一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理
一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理
一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理
afsebu
 
ColombiaPresentation.pptx macroeconomics
ColombiaPresentation.pptx macroeconomicsColombiaPresentation.pptx macroeconomics
ColombiaPresentation.pptx macroeconomics
JuanFelipeHerrera4
 
Luxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in Noida
Luxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in NoidaLuxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in Noida
Luxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in Noida
gurkirankumar98700
 
Causes Supporting Charity for Elderly People
Causes Supporting Charity for Elderly PeopleCauses Supporting Charity for Elderly People
Causes Supporting Charity for Elderly People
SERUDS INDIA
 
Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...
Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...
Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...
gourkajal4343
 
Sponsor a Child for Education & Food.pptx
Sponsor a Child for Education & Food.pptxSponsor a Child for Education & Food.pptx
Sponsor a Child for Education & Food.pptx
SERUDS INDIA
 
All Loan Insorance Are Money Problem.docx 1
All Loan Insorance Are Money Problem.docx 1All Loan Insorance Are Money Problem.docx 1
All Loan Insorance Are Money Problem.docx 1
arushiyadavp11
 
SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...
SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...
SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...
JSchaus & Associates
 
Call Girls Ahmedabad 🌹 7339748667 🌹 With No Advance Payment
Call Girls Ahmedabad 🌹 7339748667 🌹 With No Advance PaymentCall Girls Ahmedabad 🌹 7339748667 🌹 With No Advance Payment
Call Girls Ahmedabad 🌹 7339748667 🌹 With No Advance Payment
prijesh mathew
 
Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...
Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...
Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...
khannsohil539
 
G7 Apulia Leaders Communique, June 2024 (1).pdf
G7 Apulia Leaders Communique, June 2024 (1).pdfG7 Apulia Leaders Communique, June 2024 (1).pdf
G7 Apulia Leaders Communique, June 2024 (1).pdf
Energy for One World
 
Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...
Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...
Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...
deepakrana121234
 
GRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptx
GRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptxGRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptx
GRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptx
Gavin Malala
 
Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...
Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...
Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...
gurkirankumar98700
 
7339748667 Call Girls Kolkata with Trusted Models
 7339748667 Call Girls Kolkata with Trusted Models 7339748667 Call Girls Kolkata with Trusted Models
7339748667 Call Girls Kolkata with Trusted Models
Russian Escorts Delhi | 9711199171 | To Enjoy Every Moments Of Life!
 
UN SDSN Sustainable Development Report 2024
UN SDSN Sustainable Development Report 2024UN SDSN Sustainable Development Report 2024
UN SDSN Sustainable Development Report 2024
Energy for One World
 
一比一原版加拿大麦科文大学毕业证如何办理
一比一原版加拿大麦科文大学毕业证如何办理一比一原版加拿大麦科文大学毕业证如何办理
一比一原版加拿大麦科文大学毕业证如何办理
qypomky
 
GUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdf
GUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdfGUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdf
GUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdf
ProexportColombia1
 
一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理
一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理
一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理
teeaszt
 

Recently uploaded (20)

Spending in the 340B Drug Pricing Program, 2010 to 2021
Spending in the 340B Drug Pricing Program, 2010 to 2021Spending in the 340B Drug Pricing Program, 2010 to 2021
Spending in the 340B Drug Pricing Program, 2010 to 2021
 
一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理
一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理
一比一原版英国阿伯丁大学毕业证(AU毕业证书)学历如何办理
 
ColombiaPresentation.pptx macroeconomics
ColombiaPresentation.pptx macroeconomicsColombiaPresentation.pptx macroeconomics
ColombiaPresentation.pptx macroeconomics
 
Luxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in Noida
Luxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in NoidaLuxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in Noida
Luxury Call Girls Noida {9873940964} VVIP POOJA Call Girls in Noida
 
Causes Supporting Charity for Elderly People
Causes Supporting Charity for Elderly PeopleCauses Supporting Charity for Elderly People
Causes Supporting Charity for Elderly People
 
Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...
Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...
Full Night Fun With Call Girls Hyderabad📞7737669865 At Very Cheap Rates Doors...
 
Sponsor a Child for Education & Food.pptx
Sponsor a Child for Education & Food.pptxSponsor a Child for Education & Food.pptx
Sponsor a Child for Education & Food.pptx
 
All Loan Insorance Are Money Problem.docx 1
All Loan Insorance Are Money Problem.docx 1All Loan Insorance Are Money Problem.docx 1
All Loan Insorance Are Money Problem.docx 1
 
SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...
SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...
SPONSORED CONTENT - Palmetier Law - Unleashing Small Business Innovations: A ...
 
Call Girls Ahmedabad 🌹 7339748667 🌹 With No Advance Payment
Call Girls Ahmedabad 🌹 7339748667 🌹 With No Advance PaymentCall Girls Ahmedabad 🌹 7339748667 🌹 With No Advance Payment
Call Girls Ahmedabad 🌹 7339748667 🌹 With No Advance Payment
 
Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...
Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...
Russian Call Girls Visakhapatnam 8800000000 Low Rate HIgh Profile Visakhapatn...
 
G7 Apulia Leaders Communique, June 2024 (1).pdf
G7 Apulia Leaders Communique, June 2024 (1).pdfG7 Apulia Leaders Communique, June 2024 (1).pdf
G7 Apulia Leaders Communique, June 2024 (1).pdf
 
Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...
Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...
Call Girls in Kolkata (West Bengal) call me [🔝9352988975🔝] Escort In Kolkata ...
 
GRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptx
GRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptxGRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptx
GRASSROOT-MODEL GRASSROOT-MODEL GRASSROOT-MODEL.pptx
 
Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...
Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...
Call Girl Delhi 9711199012 Niamh@ Delhi Call Girls Near Me @ Sexy Call Girls ...
 
7339748667 Call Girls Kolkata with Trusted Models
 7339748667 Call Girls Kolkata with Trusted Models 7339748667 Call Girls Kolkata with Trusted Models
7339748667 Call Girls Kolkata with Trusted Models
 
UN SDSN Sustainable Development Report 2024
UN SDSN Sustainable Development Report 2024UN SDSN Sustainable Development Report 2024
UN SDSN Sustainable Development Report 2024
 
一比一原版加拿大麦科文大学毕业证如何办理
一比一原版加拿大麦科文大学毕业证如何办理一比一原版加拿大麦科文大学毕业证如何办理
一比一原版加拿大麦科文大学毕业证如何办理
 
GUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdf
GUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdfGUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdf
GUIA_LEGAL_CHAPTER_7_COLOMBIAN TAX REGIME.pdf
 
一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理
一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理
一比一原版(Adelaide毕业证)阿德莱德大学毕业证如何办理
 

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.