Scribd
Upload
19 views4 pages

DigiLocker API Integration Implementation PDF

The document outlines the integration process for the DigiLocker API, including partner registration, obtaining API credentials, user authentication, and document retrieval. It highlights commercial use cases such as KYC verification and document validation, along with considerations for cost, data privacy compliance, and technical support. Additionally, it provides a sample API sequence flow for implementing the DigiLocker services.

Uploaded by

probityakash
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
19 views4 pages

DigiLocker API Integration Implementation PDF

The document outlines the integration process for the DigiLocker API, including partner registration, obtaining API credentials, user authentication, and document retrieval. It highlights commercial use cases such as KYC verification and document validation, along with considerations for cost, data privacy compliance, and technical support. Additionally, it provides a sample API sequence flow for implementing the DigiLocker services.

Uploaded by

probityakash
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

DigiLocker API & Commercial Implementation

1. DigiLocker API Integration

Partner Registration
Register your organization on the API Setu DigiLocker Portal:
[Link]
Submit use-case justification and obtain approval from NeGD (National e-Governance
Division).

Obtain API Credentials


After approval, receive client_id, client_secret, and redirect URLs.
These are essential for OAuth-based authentication.

User Authentication & Consent


Use the Create URL API to generate a DigiLocker login and consent link.
Redirect users to DigiLocker for Aadhaar-based login and document-sharing consent.

Access Token Generation


After user consent, use the Get Access Token API to retrieve a token for further operations.
Tokens can be refreshed using the Refresh Token API.

Document Retrieval
Use the Get Document List API to fetch available documents.
Retrieve specific documents using the Get Document API (e.g., Aadhaar, PAN, Driving
License).
Documents are returned in XML or JSON format for easy parsing and storage.

Webhook Integration (Optional)


Set up webhooks to receive real-time updates on user consent and document status.

1
2. Commercial Implementation Overview
Use Cases
KYC verification for banks, NBFCs, insurance, and citizen services.
Seamless onboarding for government schemes and digital platforms.
Document validation for housing applications, training programs, etc.

Commercial Considerations
Aspect Details

Cost Model Typically free for government entities;


private orgs may need MoU/approval.

Data Privacy Compliance Must adhere to DPDPA 2023 and


DigiLocker’s consent-based access model.

Technical Support Provided via API Setu or authorized service


providers like Setu, Surepass.

Scalability Supports high-volume document retrieval


with pagination and caching.

3. Sample DigiLocker API Sequence Flow


1. Generate Consent URL
API: Create URL API
Redirect user to DigiLocker for login and consent.
URL Format: [Link]
User logs in and grants consent. Redirects back with ?code=AUTH_CODE.

2. Exchange Auth Code for Access Token


API: Get Access Token API (POST)
URL: [Link]
Send client_id, client_secret, redirect_uri and auth code.
Receive access_token and refresh_token.

2
3. Retrieve List of Documents
API: Get Document List API (GET)
URL: [Link]
Use Bearer access_token in Authorization header.

4. Retrieve Specific Document


API: Get Document API (GET)
URL: [Link]
Returns PDF/XML of requested document.

5. Refresh Token (Optional)


API: Refresh Token API (POST)
Send refresh_token, client_id, and client_secret.
Receive new access_token and refresh_token.

4. API Sequence Flow

3
5. Note:
- DigiLocker API: DigiLocker provides its API for free, promoting digital document
accessibility and verification.

- Developer Costs: However, the costs associated with integrating and implementing the API
can vary depending on the scope, complexity, and developer's requirements.

This distinction is crucial for developers and organizations planning to integrate


DigiLocker's API into their systems.

You might also like