> ## 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.

<CardGroup cols={2}>
  <Card title="Consent-based verification" icon="shield-check">
    Users authenticate via Aadhaar OTP and grant consent to share specific documents. Complies with UIDAI and RBI guidelines.
  </Card>

  <Card title="Two integration methods" icon="code">
    Backend API for full control or client-side SDK for iOS, Android, React Native, and Flutter.
  </Card>
</CardGroup>

## How it works

<Steps>
  <Step title="Initiate session">
    Generate a unique DigiLocker URL for the user to authenticate and provide consent.
  </Step>

  <Step title="User authentication">
    User logs into DigiLocker using Aadhaar-based OTP verification and grants consent to share specific documents.
  </Step>

  <Step title="Retrieve documents">
    Fetch the requested documents and extract data in PDF, JPEG, or XML format.
  </Step>
</Steps>

## What you can do

<CardGroup cols={2}>
  <Card title="Access multiple document types" icon="file-lines">
    Retrieve Aadhaar, PAN, driving license, vehicle registration, education certificates, and other government-issued documents.
  </Card>

  <Card title="Extract document data" icon="database">
    Get structured data including name, date of birth, address, gender, photo, and document-specific details.
  </Card>

  <Card title="Verify authenticity" icon="circle-check">
    Government sources provide documents directly, ensuring authenticity and reducing fraud risk.
  </Card>

  <Card title="Support existing users" icon="users">
    Works with 250M+ registered DigiLocker users and allows new users to create accounts during verification.
  </Card>
</CardGroup>

## Integration methods

<CardGroup cols={2}>
  <Card title="DigiLocker API" icon="code" href="/api-reference/kyc/digilocker/endpoints/initiate_session">
    Backend integration where you control the entire flow and handle session management.
  </Card>

  <Card title="DigiLocker SDK" icon="mobile" href="/api-reference/kyc/digilocker-sdk/getting-started/introduction">
    Client-side integration using pre-built SDKs for iOS, Android, React Native, and Flutter.
  </Card>
</CardGroup>

## 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

<AccordionGroup>
  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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
  </Accordion>
</AccordionGroup>