Skip to main content
POST
/
api
/
v1
/
sub-accounts
/
{sub_auth_id}
/
kyc
/
digilocker
/
verify
DigiLocker verify
curl --request POST \
  --url https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/verify \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "access_request_id": "AR_xxxxxxxx"
}
'
import requests

url = "https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/verify"

payload = { "access_request_id": "AR_xxxxxxxx" }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({access_request_id: 'AR_xxxxxxxx'})
};

fetch('https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "verification_type": "aadhaar",
  "status": "verified",
  "source": "digilocker"
}
Finalizes the Aadhaar verification via DigiLocker after the customer completes OAuth. Pass the access_request_id from DigiLocker Initiate. linked_number is optional (92-series per-number binding).
Authenticate with your parent main account’s X-Auth-ID and X-Auth-Token — the same credentials used everywhere else in the API.

​
Request body

FieldTypeRequiredDescription
access_request_idstringYesThe id returned by DigiLocker Initiate.
linked_numberstringNoOptional. Binds the Aadhaar to a specific 92-series number (e.g. +91XXXXXXXXXX).

​
Response example

200 OK
{
  "verification_type": "aadhaar",
  "status": "verified",
  "source": "digilocker"
}
Call this only after the customer has completed the DigiLocker OAuth flow. Calling it before the customer authorizes will not return verified.

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
sub_auth_id
string
required

The sub-account's Auth ID.

Example:

"SA_XXXXXX"

Body

application/json
​
access_request_id
string
required
Example:

"AR_xxxxxxxx"

​
linked_number
string

Optional. Binds the Aadhaar to a specific number (92-series).

Example:

"+91XXXXXXXXXX"

Response

200 - application/json

Verification result

Outcome of a single KYC verification step.

​
verification_type
enum<string>
required
Available options:
pan,
gst,
cin,
aadhaar
​
status
enum<string>
required
Available options:
verified,
failed,
pending
​
kyc_calls_blocked
boolean

Recomputed sub-account call-blocking state after this verification.

​
mock
boolean

Present and true on responses from the test-mode endpoints.