---
title: "DigiLocker initiate"
method: POST
path: "/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/initiate"
tags: ["Sub-Account KYC"]
---

# DigiLocker initiate

`POST /api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/initiate`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/initiate`
- Auth: API key in header `X-Auth-ID` and API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/sub-accounts/:sub_auth_id/kyc/digilocker/initiate/post.ts> (a function with typed inputs; its response is checked against the schema)

Returns the DigiLocker authorization link and an `access_request_id`.
The customer completes the OAuth flow on the DigiLocker portal, after
which you finalize with
[DigiLocker verify](#operation/subaccount-digilocker-verify).

## Path parameters

- `sub_auth_id` string, required

## Request body

- object
  - `redirect_url` string, uri, required
  - `oauth_state` string: Opaque value echoed back on the redirect for CSRF protection.

## Response `200`

DigiLocker authorization link

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) - [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vobiz/apis/vobiz-api/revisions/863f08cd6737?raw)