DigiLocker Server SDK

Ready-to-use **Node.js / TypeScript SDK** for integrating DigiLocker via your backend.

This SDK is **server-side only** and is designed to work with a backend that proxies DigiLocker APIs.

📦 Installation (Add SDK to your project)

npm install @azlogicsindia/digilocker-server-sdk

🚀 Usage

1️⃣ Import the SDK

import { DigilockerSDK } from "@azlogicsindia/digilocker-server-sdk";

2️⃣ Initialize the SDK

const digilocker = new DigilockerSDK({
  baseUrl: "https://your-backend-api.com",
  token: "YOUR_CLIENT_TOKEN",
  secretkey: "YOUR_CLIENT_SECRET"
});

⚠️ These credentials must be kept server-side only.

🔄 DigiLocker Flow

• STEP 1: Open DigiLocker (Redirect User)

Generate the DigiLocker redirect URL and send the user to it.

const redirectUrl = digilocker.openDigilocker();

// Redirect user (example in Express)
res.redirect(redirectUrl);

This method only returns a URL. No API call is made from the SDK.

• STEP 2: Handle DigiLocker Callback & Fetch Documents

After DigiLocker authentication, you will receive a code in your callback URL.

Example callback:

https://yourapp.com/digilocker/callback?code=XXXX

Use that code to fetch DigiLocker documents:

const code = req.query.code as string;

const documents = await digilocker.fetchDocuments(code);

console.log(documents);

✅ This method:

Calls your backend API

Handles Axios errors

Throws structured SDK errors

• STEP 3: Logout from DigiLocker (Optional)

To log the user out of DigiLocker (browser-based):

const logoutUrl = digilocker.getLogoutUrl();

// Redirect user
res.redirect(logoutUrl);

⚠️ Logout must be done via browser redirect, not Axios.