---
title: "Get sub-account KYC status"
method: GET
path: "/api/v1/sub-accounts/{sub_auth_id}/kyc/status"
tags: ["Sub-Account KYC"]
---

# Get sub-account KYC status

`GET /api/v1/sub-accounts/{sub_auth_id}/kyc/status`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc/status`
- 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/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the aggregated KYC state for a `customer_use` sub-account —
which verifications have passed, whether calls are still blocked, and
the business type. The caller must be the parent main account that owns
the sub-account (or an admin).

## Path parameters

- `sub_auth_id` string, required

## Response `200`

Aggregated KYC state

- SubAccountKycStatus: Aggregated KYC state for a sub-account.
  - `sub_account_id` string
  - `kyc_mode` 'personal_use' | 'customer_use'
  - `business_type` string
  - `overall_status` '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.

## Other responses

- `403`: Caller is not the parent of this sub-account
- `404`: Sub-account not found

---

[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)