Create sub-account
create_sub_accountProvision a Vobiz sub-account under a main account, requiring only a name. For customer_use KYC, an email is required; calls require separate KYC approval.
Instructions
Create a Vobiz sub-account under this main account (only name is required). kyc_mode customer_use needs email, and the new sub-account places calls only after its own KYC (see create_sub_account_kyc_session). The new sub-account's credentials are not returned here; the user copies them from the Vobiz console. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable name for the sub-account. | |
| No | Contact email. Required for kyc_mode customer_use. | ||
| phone | No | ||
| confirm | Yes | Must be true, set only after the user explicitly approved: creating this sub-account. | |
| enabled | No | Whether the sub-account can be used (default true). | |
| kyc_mode | No | personal_use (default) uses the parent's KYC; customer_use means the sub-account completes its own KYC before placing calls (needs email). | |
| rate_limit | No | API rate limit for the sub-account (Vobiz default 1000). | |
| description | No | ||
| permissions | No | Access flags. Omitted on create: the sub-account inherits the parent's default access. | |
| business_type | No | Legal constitution of the customer; decides which KYC documents are collected. |