ADocumentation Index
Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt
Use this file to discover all available pages before exploring further.
customer_use sub-account must complete its own KYC before it can place calls. Until it does, the sub-account is returned with kyc_calls_blocked: true. This section documents the per-sub-account KYC API used to drive that verification.
Authentication: Sub-account KYC endpoints authenticate as the parent main account that owns the sub-account (or an admin), using a JWT bearer token:This is different from the
X-Auth-ID / X-Auth-Token header pair used elsewhere in the API.When KYC applies
kyc_mode | KYC required? | Notes |
|---|---|---|
personal_use (default) | No | The sub-account inherits the parent account’s KYC. |
customer_use | Yes | The sub-account must verify itself. Requires an email. Fresh sub-accounts start with kyc_calls_blocked: true. |
kyc_mode at creation or promote an existing sub-account.
Verification paths
There are two ways to complete KYC for acustomer_use sub-account:
Per-document API
Drive each step yourself — PAN, GST, CIN, or Aadhaar via DigiLocker — and poll the aggregated status.
Hosted session
Hand the customer a Vobiz-hosted link (email) or redirect them inline to the hosted widget.
Document requirements by entity
Entity (business_type) | Typical documents |
|---|---|
individual, proprietorship, huf | PAN + Aadhaar (via DigiLocker) |
private_limited, public_limited, llp, partnership | PAN + GST and/or CIN |
trust, society, government | PAN + supporting registration (CIN/GST as applicable) |
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /sub-accounts/{sub_auth_id}/kyc/status | Aggregated KYC state |
| POST | /sub-accounts/{sub_auth_id}/kyc/verify-pan | Verify PAN |
| POST | /sub-accounts/{sub_auth_id}/kyc/verify-gst | Verify GST |
| POST | /sub-accounts/{sub_auth_id}/kyc/cin/search | CIN search |
| POST | /sub-accounts/{sub_auth_id}/kyc/cin/confirm | CIN confirm |
| POST | /sub-accounts/{sub_auth_id}/kyc/digilocker/initiate | DigiLocker initiate |
| POST | /sub-accounts/{sub_auth_id}/kyc/digilocker/verify | DigiLocker verify |
| POST | /sub-accounts/{sub_auth_id}/kyc-sessions | Create a hosted KYC session |