DigiLocker session status webhook

{
  "data": {
    "id": "839fd8a0-d645-42e1-a904-bb43353b0139",
    "created_at": 1752579445983,
    "updated_at": 1752579512340,
    "@entity": "in.co.sandbox.kyc.digilocker.session",
    "status": "succeeded",
    "documents_consented": [
      "aadhaar",
      "pan"
    ]
  }
}

WEBHOOK

DigiLockerSessionStatus

{
  "data": {
    "id": "839fd8a0-d645-42e1-a904-bb43353b0139",
    "created_at": 1752579445983,
    "updated_at": 1752579512340,
    "@entity": "in.co.sandbox.kyc.digilocker.session",
    "status": "succeeded",
    "documents_consented": [
      "aadhaar",
      "pan"
    ]
  }
}

Webhooks fire when a DigiLocker session moves from created to succeeded or failed, so you don’t need to poll the session status. The webhook’s data contains the session, with the same schema as data in the session status response. After succeeded, read data.documents_consented and fetch each document. A session failed when the user denies consent or the authorization can’t be completed. Configure the webhook before initiating sessions. See the webhooks guide to set your URL and validate x-sandbox-signature.

Body

application/json

DigiLocker session status notification.

data

object

required

Session details use the same schema as data in the DigiLocker session status response.

Show child attributes

Response

200

Return a 2xx status to acknowledge receipt of the notification.

Aadhaar

Bank

DigiLocker

EntityLocker

MCA

PAN

Annexures

DigiLocker session status webhook

Body

Response