Skip to main content
POST
DigiLocker document pull

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <your-key>.

Body

application/json

The document to pull from its issuer, found by the search parameters its type requires.

request_id
string
required

The request_id the consent link was created with

Minimum string length: 1
Example:

"652523835a9f9000112b1ee6"

doc_type
string
required

The document type, as /digilocker/v1/document-types.1 lists it

Minimum string length: 1
Example:

"PANCR"

org_id
string
required

The issuer's organisation id, as /digilocker/v1/document-types.1 lists it

Minimum string length: 1
Example:

"001891"

Whether the person consents to the document being pulled

Available options:
Y,
N
search_parameters
Search Parameters · object
required

The search parameters the document type requires, each named exactly as Document types lists it in parameter_name.

Example:
get_base64_files
boolean | null

Whether files come back as base64 in place of a download link

get_e_aadhaar_pdf
boolean | null

Whether the e-Aadhaar PDF comes back

Response

Successful Response

A document pulled from its issuer into the person's DigiLocker account.

details
PulledDocument · object
required

The document, and its file id