Skip to main content
POST
/
api
/
v1
/
sub-accounts
/
{sub_auth_id}
/
kyc
/
digilocker
/
initiate
DigiLocker initiate
curl --request POST \
  --url https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "https://partner.example.com/kyc/callback"
}
'
{
  "auth_url": "https://api.digitallocker.gov.in/public/oauth2/1/authorize?...",
  "access_request_id": "AR_xxxxxxxx"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

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

Starts a DigiLocker-based Aadhaar verification. Returns the DigiLocker authorization link and an access_request_id. Redirect the customer to the link to complete OAuth on the DigiLocker portal, then finalize with DigiLocker Verify.
Authenticate as the parent main account with Authorization: Bearer {parent_jwt}.
1

Initiate

Call this endpoint with your redirect_url (and optional oauth_state). Capture access_request_id and send the customer to the returned auth_url.
2

Customer completes OAuth

The customer authorizes on the DigiLocker portal and is returned to your redirect_url.
3

Verify

Call DigiLocker Verify with the access_request_id.

Authorizations

​
Authorization
string
header
required

Parent main-account JWT. Sub-account KYC endpoints authenticate as the parent account that owns the sub-account (or an admin), not with the X-Auth-ID / X-Auth-Token header pair.

Path Parameters

​
sub_auth_id
string
required

The sub-account's Auth ID.

Example:

"SA_XXXXXX"

Body

application/json
​
redirect_url
string<uri>
required
Example:

"https://partner.example.com/kyc/callback"

​
oauth_state
string

Opaque value echoed back on the redirect for CSRF protection.

Example:

"opaque-state-xyz"

Response

200 - application/json

DigiLocker authorization link