Skip to main content
POST
DigiLocker consent link

Authorizations

Authorization
string
header
required

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

Body

application/json

How the DigiLocker consent is presented, where the person and the result go, and what it returns.

Every field is optional.

signup
boolean | null

Whether a person without a DigiLocker account may create one during the consent. An account created this way has to be linked to its Aadhaar number in DigiLocker before any document can be read from it.

success_redirect_url
string<uri> | null

Where the person is sent after giving consent

Required string length: 1 - 2083
success_redirect_time
integer | null

Seconds before the person is sent to success_redirect_url. Defaults to 10

Required range: x >= 0
failure_redirect_url
string<uri> | null

Where the person is sent when the consent is not given

Required string length: 1 - 2083
failure_redirect_time
integer | null

Seconds before the person is sent to failure_redirect_url. Defaults to 10

Required range: x >= 0
doc_type
string[] | null

The DigiLocker document types the person is asked to share, and the only ones the consent screen shows. Defaults to ["PANCR", "ADHAR", "DRVLC"]: PAN, Aadhaar and driving licence.

Minimum array length: 1
Minimum string length: 1
Example:
purpose
enum<string> | null

Why the person is asked for their consent

Available options:
kyc,
verification,
compliance,
availing_services,
educational
get_scope
boolean | null

Whether the callback reports what the person gave access to

internal_id
string | null

Your own reference for this consent, carried back on the callback

pinless_authentication
boolean | null

Whether the person may sign in to DigiLocker on their phone without a PIN

callback_url
string<uri> | null

Where the consent's result is sent, as a JSON POST, once the person has given it. Must be an https URL.

Required string length: 1 - 2083
persist_password
string | null

A password the files read through this consent are protected with

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

get_e_aadhaar_jpeg
boolean | null

Whether the e-Aadhaar JPEG comes back

Response

Successful Response

The DigiLocker link to send the person to, and the id their consent is read by.

details
DigilockerUrl · object
required

The consent link and its request id