VOvobiz
Sub-Account KYC

Get sub-account KYC status

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

get/api/v1/sub-accounts/{sub_auth_id}/kyc/status

Request

Path parameters

sub_auth_idstring required
Example:SA_XXXXXX

The sub-account's Auth ID.

Response

Aggregated KYC state

sub_account_idstring
kyc_mode'personal_use' | 'customer_use'
business_typestring
overall_status'not_started' | 'pending' | 'verified' | 'failed'
kyc_calls_blockedboolean

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

verificationsobject

Per-document state keyed by verification type.

Changes

No recorded changes to this operation across all 1 revision of this API.