API Reference

Initiate Session

post
https://api.sandbox.co.in/kyc/digilocker/sessions/init

The Initiate Session API returns a DigiLocker link that the user is redirected to, where they can provide consent for the requested documents.

Important Links
Run in PostmanStart a Free Trial
Body Params
string
required
Defaults to in.co.sandbox.kyc.digilocker.session.request

Request Entity

string
enum
required
Defaults to signin

Indicates whether the user is signing in or signing up on DigiLocker

Allowed:
doc_types
array of strings
required
Defaults to aadhaar

Documents you need consent for. Possible values: aadhaar, pan, driving_license

doc_types*
string
required

The URL to redirect the user post consent is received

int32

Consent expiry in epoch (10 digit), must be at least 1 hour later than the current time. Default is 1 hour from now.

options
object

Additonal options for customizing user experience

Headers
string
required

JWT access token

string
required

API key for identification

Response

Updated 9 months ago

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

Updated 9 months ago