Create Session

POST /kyc/digilocker-sdk/sessions/create

cURL

200 - OK

curl --request POST \
  --url https://test-api.sandbox.co.in/kyc/digilocker-sdk/sessions/create \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.kyc.digilocker.sdk.session.request",
  "flow": "signin",
  "doc_types": [
    "aadhaar",
    "pan"
  ]
}
'

200

{
  "timestamp": 1750331120324,
  "transaction_id": "5ccad959-0bf4-4472-a3dd-d57e2b61b5a9",
  "data": {
    "@entity": "in.co.sandbox.kyc.digilocker.sdk.session",
    "id": "0454f149-26d0-41ef-9f14-c54f4b5f7b70",
    "status": "created",
    "created_at": 1750331120324
  },
  "code": 200
}

{
  "code": 400,
  "timestamp": 1760426007752,
  "message": "Invalid request body",
  "transaction_id": "f654ccdb-919f-486d-851d-0fc5d0050c17"
}

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.sdk.session.request

flow · enum<string> · required

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

Available options: signin, signup

doc_types · enum<string>[] · required

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

Minimum array length: 1

Available options: aadhaar, driving_license, pan

Response

200

application/json

timestamp · integer · required

transaction_id · string · required

data · object · required

Show child attributes

code · integer · required