Authorized Partner API Specification API

by digitallocker.gov.in

Overview

To access files in user’s DigiLocker account from your application, you must first obtain user’s authorization.

Authorized Partner API Specification is an open data API from digitallocker.gov.in. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 22 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Open Data
Base URL: https://betaapi.digitallocker.gov.in/public
Version: 1.0.0
Endpoints: 22
OpenAPI: Specification ↗
Spec updated: 2021-02-07

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://betaapi.digitallocker.gov.in/public/oauth2/1/authorize" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://betaapi.digitallocker.gov.in/public/oauth2/1/authorize", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://betaapi.digitallocker.gov.in/public/oauth2/1/authorize",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/account/1/pushuri`	Push URI to Account
POST	`/account/2/verify`	Verify Account
GET	`/oauth2/1/authorize`	Get Authorization Code
POST	`/oauth2/1/code`	Get Device Code
POST	`/oauth2/1/file/upload`	Upload file to locker
GET	`/oauth2/1/file/{uri}`	Get File from URI
GET	`/oauth2/1/files/`	Get List of Self Uploaded Documents
GET	`/oauth2/1/files/issued`	Issued Documents
GET	`/oauth2/1/files/{id}`	Get List of Self Uploaded Documents
POST	`/oauth2/1/pull/doctype`	Get List of Documents Provided by an Issuer
POST	`/oauth2/1/pull/issuers`	Get List of Issuers
POST	`/oauth2/1/pull/parameters`	Get Search Parameters for a Document
POST	`/oauth2/1/pull/pulldocument`	Pull Document
POST	`/oauth2/1/revoke`	Revoke Token.
POST	`/oauth2/1/token`	Get Access Token
GET	`/oauth2/1/user`	Get User Details
GET	`/oauth2/1/xml/{uri}`	Get Certificate Data in XML Format from URI
GET	`/oauth2/2/files/issued`	Issued Documents
GET	`/oauth2/2/xml/eaadhaar`	Get e-Aadhaar Data in XML Format
POST	`/signup/1/demoauthverify`	Verify OTP
POST	`/signup/2/demoauth`	SIGN UP
POST	`/statistics/1/counts`	Get Statistics