HomeAbout
Join Today
  • Sign Up
  • Sign In
Conatct Us
HomeAbout
Join Today
  • Sign Up
  • Sign In
Conatct Us
  1. Digilocker
  • Introduction
  • Getting Started
  • Authentication
  • HTTPS Status Codes
  • Rate Limits
  • Verification Suite
    • Digilocker
      • Initiate
        POST
      • Check Status
        GET
      • Download Aadhaar
        GET
    • Aadhaar
      • Send OTP
      • Verify OTP
    • UPI Verification
      POST
    • Bank Verification
      POST
    • PAN Verification
      POST
    • GSTIN Verification
      POST
  • NSDL Account Opening
    • BC Agent Onboarding
      POST
    • Create Account
      POST
    • Account Status
      GET
  • Comunications API
    • Send SMS OTP
      POST
    • Send Whatsapp OTP
      POST
  1. Digilocker

Download Aadhaar

GET
/api/v1/digilocker/downloadAadhaar/{requestId}

📑 Fetch DigiLocker Documents#

Retrieve authenticated documents and verified user details from DigiLocker after the user has completed the consent journey, ensuring secure and compliant digital KYC.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/digilocker/downloadAadhaar/' \
--header 'x-client-id: {{client_id}}' \
--header 'x-client-secret: {{client_secret}}' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body

Example
{
    "response_code": 200,
    "status": "success",
    "message": "Success",
    "data": {
        "name": "Aadhaar Card",
        "doc_type": "UIADHAR",
        "verification_completed": true,
        "issuer": "Unique Identification Authority of India (UIDAI)",
        "aadhaar_data": {
            "full_name": "John Doe",
            "care_of": "S/O: Mr. Johnson",
            "dob": "1987-01-01",
            "yob": "1987",
            "zip": "324324",
            "profile_image": "<base64 encode image >",
            "gender": "M",
            "masked_aadhaar": "XXXXXXXX1111",
            "full_address": "Rajiv Gandhi Infotech Park Road, Near Infosys Circle, Phase 1, Hinjewadi, Mulshi, Pune, Maharashtra, India",
            "father_name": "S/O: Mr. Johnson",
            "address": {
                "country": "India",
                "dist": "Pune",
                "state": "Maharashtra",
                "po": "Hinjewadi",
                "house": "",
                "loc": "Phase 1",
                "vtc": "Hinjewadi",
                "subdist": "Mulshi",
                "street": "Rajiv Gandhi Infotech Park Road",
                "landmark": "Near Infosys Circle"
            }
        }
    },
    "meta": {
        "request_id": "e37ec9dc-bcf6-419e-a12d-6406b370ea29",
        "time": "2022-08-30T20:55:12+05:30"
    }
}
🟠404Record Not Found
🟠400Bad Request
Previous
Check Status
Next
Send OTP
Built with