Skip to main content
POST
DigiLocker aggregate (one-call convenience)

Authorizations

x-api-key
string
header
required

Your API key for authentication. Use sandbox-with-json-responses as Sandbox key.

Path Parameters

session_id
string
required

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

Body

application/json
fetch_documents
enum<string>[]

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

Available options:
pan,
aadhaar,
driving_licence
Example:
include_documents
boolean
default:true

Include the issued-documents list.

Response

Aggregate result (sections present per availability)

status
string
Example:

"success"

identity
object | null

The investor's verified identity. Only fields the investor shared are populated. verified contains the authenticated document identifiers (e.g. PAN, Aadhaar number).

Consent receipt captured at session start. Carried through the flow for audit (DPDP / RBI compliance).

consented_documents
string[]

Friendly names of documents the user consented to share.

Example:
documents
object[]
fetched
object

Parsed documents keyed by the fetch_documents value (pan/aadhaar/driving_licence). Value is null if the document was requested but unavailable. Each parsed object also includes a signature block.

errors
object

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