Skip to main content
POST
/
kyc
/
entitylocker
/
sessions
/
init
Initiate session
curl --request POST \
  --url https://api.sandbox.co.in/kyc/entitylocker/sessions/init \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.kyc.entitylocker.session.request",
  "flow": "signin",
  "redirect_url": "https://sandbox.co.in"
}
'
{
  "code": 200,
  "timestamp": 1765534184274,
  "data": {
    "@entity": "in.co.sandbox.kyc.entitylocker.session.response",
    "authorization_url": "https://entity.digilocker.gov.in/public/oauth2/1/authorize?response_type=code&client_id=VRF23C1E3B&redirect_uri=https%3A%2F%2Fdev-api.sandbox.co.in%2Fcallbacks%2Fkyc%2Fentitylocker%2Foauth&state=ZDgyMDM0NzItMTFiMC00ZGRhLWFlOWItY2U0YzI0OTRmMWRkfGQzZjg4OTdlLWYxZmYtNDQ0OS05NzA0LTcwNzNmNjkzMDI5NnxodHRwczovL3NhbmRib3guY28uaW4v&code_challenge=yxAtiqiBw2FrXmavMHn7bVnq7nW-sWRNI50JTMuYtAE&code_challenge_method=S256&consent_valid_till=1767205777",
    "session_id": "d3f8897e-f1ff-4449-9704-7073f6930296"
  },
  "transaction_id": "02683ff9-2abc-42ab-a050-945f21068bce"
}
https://mintcdn.com/sandboxfinancialtechnologiesprivatelimited/E4RwGFBROD75hm3P/static/svg/Postman.svg?fit=max&auto=format&n=E4RwGFBROD75hm3P&q=85&s=bf60d58751a51f6e80a8f2cdae74c9fc

Run in Postman

Headers

Authorization
string
required

JWT access token

x-api-key
string
required

API key for identification

x-api-version
string

Body

application/json
@entity
string
required
Allowed value: "in.co.sandbox.kyc.entitylocker.session.request"
flow
enum<string>
required

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

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

The URL to redirect the user post consent is received

The expiry of the consent that the user provides. Should be a minimum of 1 hour from current timestamp.

Response

200 - application/json

200 - Session initiated

code
integer
timestamp
integer
data
object
transaction_id
string