Skip to main content
POST
Initiate session

Run in Postman

Headers

Authorization
string
required

JWT access token. For token-generation steps, refer to the Quickstart Guide.

x-api-key
string
required

API key used to identify and authenticate the client.

x-api-version
string

Specifies the API version for the request.

Content-Type
enum<string>

Media type of the request body.

Available options:
application/json

Body

application/json
@entity
enum<string>
required
Available options:
in.co.sandbox.kyc.digilocker.session.request
flow
enum<string>
required

Authentication flow to initiate on DigiLocker. Use signin for existing users or signup to create a new DigiLocker account.

Available options:
signin,
signup
redirect_url
string<uri>
required

HTTPS URL where the user will be redirected after granting or denying DigiLocker consent. Must be a valid, publicly accessible URL.

Pattern: ^https://
doc_types
enum<string>[]
required

List of DigiLocker document types for which user consent is being requested.

Minimum array length: 1
Available options:
aadhaar,
pan,
driving_license
Minimum string length: 1
options
object

Configuration object controlling the DigiLocker authentication and sign-up user experience.

Unix epoch timestamp (milliseconds) after which the consent request expires. Must be at least 1 hour in the future.

Response

200 - application/json
code
integer
required
timestamp
integer
required
data
object
required
transaction_id
string
required