Sign in

v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-022830130.4 KB
KYC

DigiLocker aggregate (one-call convenience)

Return everything available for a DigiLocker session in a single call. Each section is independent: if one is unavailable (e.g. the investor didn't consent to it), it's reported under errors and the rest of the response still succeeds.

  • identity — verified identity, when requested via documents (free).
  • documents — list of the investor's documents (free). Set include_documents: false to skip.
  • fetched — for each document in fetch_documents, the parsed document data.

Credits: 0.25 per call, regardless of how many documents are fetched or whether identity is returned.

post/v1/kyc/digilocker/result/{session_id}

Path parameters

session_idstring required

The session_id returned by /v1/kyc/digilocker/session.

Request body

fetch_documentsstring[]

Documents to additionally fetch + parse from the locker. Default: [] (no document fetch, no fetch billing).

include_documentsboolean

Include the issued-documents list.

Example request

{
  "fetch_documents": [
    "pan",
    "driving_licence"
  ]
}

Response

Aggregate result (sections present per availability)

statusstring
consented_documentsstring[]

Friendly names of documents the user consented to share.

errorsobject

Per-section error codes (omitted when there are none).

Example response

{
  "status": "success",
  "identity": {
    "name": "Anjali Sharma",
    "dob": "1990-05-16",
    "gender": "F",
    "email": "anjali@example.com",
    "mobile": "98XXXXXX10",
    "digilocker_id": "rahul22031995",
    "username": "rahul22031995",
    "care_of": "S/O Rajesh Sharma",
    "verified": {
      "pan": "ABCDE1234F",
      "aadhaar": "XXXXXXXX1234",
      "driving_licence": "KA01-20110012345"
    }
  },
  "consent": {
    "purpose": "KYC for loan account opening",
    "consented_at": "2026-05-30T22:37:17+00:00"
  },
  "consented_documents": [
    "pan",
    "driving_licence"
  ],
  "documents": [
    {
      "name": "PAN Verification Record",
      "type": "file",
      "doctype": "PANCR",
      "issuer": "Income Tax Department",
      "issuerid": "in.gov.pan",
      "uri": "in.gov.pan-PANCR-xxxxxxxxxxxx",
      "mime": [
        "application/pdf",
        "application/xml"
      ],
      "date": "2024-09-19"
    }
  ],
  "fetched": {
    "pan": {
      "pan": "ABCPD1234E",
      "name": "RAHUL SHARMA",
      "dob": "22-03-1995",
      "gender": "MALE",
      "status": "A",
      "verified_on": "31-05-2026 03:55:02",
      "signature": {
        "signature_present": true,
        "certificate": {
          "subject": "C=IN,O=DIGITAL INDIA CORPORATION,CN=DS DIGITAL INDIA CORPORATION"
        }
      }
    },
    "aadhaar": {
      "name": "Anjali Sharma",
      "dob": "16-05-1990",
      "gender": "F",
      "care_of": "S/O Rajesh Sharma",
      "address": "12, MG Road, Indiranagar, Bengaluru, Karnataka, 560038, India",
      "masked_aadhaar": "XXXXXXXX1234"
    },
    "driving_licence": {
      "dl_number": "KA0120190008989",
      "name": "Rahul Sharma",
      "father_name": "Suresh Sharma",
      "dob": "1995-03-22",
      "gender": "M",
      "status": "A",
      "issued_at": "RTO, Bengaluru",
      "signature": {
        "signature_present": true,
        "certificate": {
          "subject": "C=IN,O=DIGITAL INDIA CORPORATION,CN=DS DIGITAL INDIA CORPORATION"
        }
      }
    }
  }
}