Skip to main content
GET
/
api
/
v1
/
sub-accounts
/
{sub_auth_id}
/
kyc
/
status
Get sub-account KYC status
curl --request GET \
  --url https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/status \
  --header 'Authorization: Bearer <token>'
{
  "sub_account_id": "SA_XXXXXX",
  "kyc_mode": "customer_use",
  "business_type": "private_limited",
  "overall_status": "pending",
  "kyc_calls_blocked": true,
  "verifications": {
    "pan": "verified",
    "gst": "pending",
    "aadhaar": "not_started",
    "cin": "not_started"
  }
}

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.

Returns the aggregated KYC state for a customer_use sub-account: the per-document verification states, whether calls are still blocked (kyc_calls_blocked), and the business_type.
Authenticate as the parent main account with Authorization: Bearer {parent_jwt}. The caller must own the sub-account (or be an admin).

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"

Response

Aggregated KYC state

Aggregated KYC state for a sub-account.

​
sub_account_id
string
​
kyc_mode
enum<string>
Available options:
personal_use,
customer_use
​
business_type
string
​
overall_status
enum<string>
Available options:
not_started,
pending,
verified,
failed
​
kyc_calls_blocked
boolean

True while the sub-account still needs KYC before it can place calls.

​
verifications
object

Per-document state keyed by verification type.