Skip to main content
POST
/
kyc
/
entitylocker-sdk
/
sessions
/
create
Create Session
curl --request POST \
  --url https://test-api.sandbox.co.in/kyc/entitylocker-sdk/sessions/create \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.kyc.entitylocker.sdk.session.request",
  "flow": "signin",
  "doc_types": [
    "company_master_details",
    "gstn_details",
    "udhyam_certificate"
  ]
}
'
{
  "timestamp": 1750331120324,
  "transaction_id": "5ccad959-0bf4-4472-a3dd-d57e2b61b5a9",
  "data": {
    "@entity": "in.co.sandbox.kyc.entitylocker.sdk.session",
    "id": "0454f149-26d0-41ef-9f14-c54f4b5f7b70",
    "status": "created",
    "created_at": 1750331120324
  },
  "code": 200
}

Documentation Index

Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt

Use this file to discover all available pages before exploring further.

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.entitylocker.sdk.session.request
ā€‹
flow
enum<string>
required

EntityLocker authentication flow to initiate for the user. Use signin for existing EntityLocker users or signup to create a new account.

Available options:
signin,
signup
ā€‹
doc_types
enum<string>[]
required

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

Minimum array length: 1
Available options:
company_master_details,
gstn_details,
udhyam_certificate

Response

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