Create DigiLocker URL

Use this API to create a DigiLocker URL to retrieve and verify aadhaar information of your customer.

Response

You get the following key information in the data object of the response:

NameData TypeDescription
reference_idintegerThe unique ID for reference purposes
urlstringThe URL received to retrieve and verify aadhaar information from DigiLocker
document_requestedArray of stringThe list of documents requested for verification
redirect_urlstringThe URL entered in the request that takes the user to after completing the DigiLocker journey
Body Params
string
required

Your registered mobile number (See Platform Credentials for UAT)

string
required

A unique ID for every API call generated at your end

document_requested
array of strings
required
Defaults to ["AADHAAR"]

A list of customer documents required for verification. Currently, only "AADHAAR" is supported.

document_requested*
string
required

A URL to take the user to after completing the DigiLocker journey. It will contain the verification_id that can be used to get the status of the verification.

string
required

Partner's eko code

Headers
string
required

Your static API key (See Guide)

string
required

Your dynamically generated security key, unique for every request (See Guide)

string
required

The current timestamp used to generate secret-key

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json