---
title: "Initiate DigiLocker session"
method: POST
path: "/verify/digilocker/initiate_session"
tags: ["DigiLocker"]
---

# Initiate DigiLocker session

`POST /verify/digilocker/initiate_session`

Initiates a DigiLocker session for the user. Requires user consent and redirect information. Accepts a JSON body with user_id (optional), consent (bool), consent_purpose (string), redirect_url (string), redirect_to_signup (bool, optional), documents_for_consent (array, optional) and state (string, optional).

| HTTP Status | Code  | Reason               | Message                              | Merchant Action                           |
|-------------|-------|----------------------|---------------------------------------|-------------------------------------------|
| 200         | 1000  | AUTH_URL_GENERATED   | Authorization URL generated.          | Redirect user to URL.                     |
| 400         | 3001  | INVALID_DOC_CODE     | One or more documents_for_consent invalid. | Pass correct document codes from master list. |
| 400         | 3002  | MISSING_REDIRECT_URL | redirect_url missing.                 | Pass valid redirect URL.                  |

## Request body

- DigilockerInitiateSessionRequest
  - `consent` boolean, required
  - `consent_purpose` string, required
  - `redirect_url` string, uri, required
  - `redirect_to_signup` boolean
  - `documents_for_consent` string[]
  - `state` string, nullable — Optional opaque value that will be returned as the `state` query parameter on the redirect URL.

## Response `200`

Authorization URL generated

- DigilockerInitiateSessionResponse
  - `status` string, required
  - `code` integer, required
  - `url` string, uri, required — Authorization URL. The original `state` (if provided) is included as the `state` query parameter.
  - `chargeble` string
  - `user_consent` string

---

[API](https://skmtc.dev/idto/apis/verification-api.md) · [All operations](https://skmtc.dev/idto/apis/verification-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/idto/verification-api/revisions/e3d57dab8db4/schema)