> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Retrieve government-issued documents from DigiLocker via consent-based verification

# DigiLocker API

DigiLocker is a government platform for storing and sharing documents digitally. Use this API to retrieve government-issued documents from your users' DigiLocker accounts after they grant consent.

This API enables consent-based document retrieval following UIDAI and RBI guidelines for identity verification and KYC compliance.

> **Consent-based verification**
>
> Users authenticate via Aadhaar OTP and grant consent to share specific documents. Complies with UIDAI and RBI guidelines.

> **Two integration methods**
>
> Backend API for full control or client-side SDK for iOS, Android, React Native, and Flutter.

## How it works

**1. Initiate session**

Generate a unique DigiLocker URL for the user to authenticate and provide consent.

**2. User authentication**

User logs into DigiLocker using Aadhaar-based OTP verification and grants consent to share specific documents.

**3. Retrieve documents**

Fetch the requested documents and extract data in PDF, JPEG, or XML format.

## What you can do

> **Access multiple document types**
>
> Retrieve Aadhaar, PAN, driving license, vehicle registration, education certificates, and other government-issued documents.

> **Extract document data**
>
> Get structured data including name, date of birth, address, gender, photo, and document-specific details.

> **Verify authenticity**
>
> Government sources provide documents directly, ensuring authenticity and reducing fraud risk.

> **Support existing users**
>
> Works with 250M+ registered DigiLocker users and allows new users to create accounts during verification.

> **[Get notified on consent](https://developer.sandbox.co.in/api-reference/kyc/digilocker/endpoints/webhook.md)**
>
> Receive a webhook when a session succeeds or fails, instead of polling the session status.

## Integration methods

> **[DigiLocker API](https://developer.sandbox.co.in/api-reference/kyc/digilocker/endpoints/initiate_session.md)**
>
> Backend integration where you control the entire flow and handle session management.

> **[DigiLocker SDK](https://developer.sandbox.co.in/api-reference/kyc/digilocker-sdk/getting-started/introduction.md)**
>
> Client-side integration using pre-built SDKs for iOS, Android, React Native, and Flutter.

## Common use cases

Use DigiLocker API when you need to:

* Verify user identity during account creation or onboarding
* Retrieve address proof for KYC compliance
* Validate driving licenses for driver verification
* Access PAN details for financial services
* Verify educational certificates for employment or admissions
* Retrieve vehicle registration documents
* Replace manual document collection with digital verification

## Frequently Asked Questions

> **What is DigiLocker?**
>
> A flagship initiative under Digital India Mission, DigiLocker is a secure cloud-based platform for storage, sharing and verification of documents & certificates.

> **How does DigiLocker API work?**
>
> DigiLocker API enables consent-based document retrieval. Users authenticate via Aadhaar OTP, grant consent to share specific documents, and you receive verified document data instantly through our API.

> **What details can I fetch from DigiLocker API?**
>
> You can fetch comprehensive details including name, date of birth, address, gender, photo, parent's name, and document-specific information. Documents are available in PDF, JPEG, and XML formats.

> **How to get Aadhaar details if a user doesn't have a DigiLocker account?**
>
> Users can create a DigiLocker account instantly during the verification process using their Aadhaar number and OTP. No pre-registration required.

> **Can someone else enter details on the DigiLocker page on user's behalf?**
>
> No. DigiLocker authentication requires the user's Aadhaar-linked mobile number for OTP verification, ensuring only the legitimate user can authorize document sharing.

> **Who can fetch documents from DigiLocker?**
>
> Only authorized entities registered as Requestor Organizations with DigiLocker can fetch documents. Sandbox is a certified Technology Solution Provider (TSP), enabling you to access DigiLocker through our API.

> **What are issued documents and uploaded documents on DigiLocker?**
>
> * **Issued Documents**: Government-issued documents directly available in DigiLocker (e.g., Aadhaar, PAN, Driving License)
> * **Uploaded Documents**: Documents uploaded by users to their DigiLocker account
>
> You can fetch both types through our API with user consent.

> **What is the difference between DigiLocker API and DigiLocker SDK?**
>
> **DigiLocker API**: Backend integration with full control, ideal for custom workflows\
> **DigiLocker SDK**: Client-side integration with pre-built UI for faster implementation


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.