VOvobiz
Sub-Accounts

Create a sub-account

Create a new sub-account under the master account.

Set kyc_mode to control how the sub-account is verified:

  • personal_use (default) — the sub-account inherits the parent's KYC; no separate verification is required.
  • customer_use — the sub-account must complete its own KYC before it can place calls. A fresh customer_use sub-account is returned with kyc_calls_blocked: true. customer_use requires email.
post/api/v1/accounts/{auth_id}/sub-accounts/

Request

Path parameters

auth_idstring required
Example:MA_XXXXXX

Your account Auth ID

Request body

namestring required

Human-readable name for the sub-account.

emailstring email

Required when kyc_mode is customer_use.

passwordstring

Login password for the sub-account.

kyc_mode'personal_use' | 'customer_use'

personal_use inherits parent KYC. customer_use requires the sub-account to complete its own KYC and requires email.

business_type'individual' | 'proprietorship' | 'private_limited' | 'llp' | 'partnership' | 'public_limited' | 'trust' | 'society' | 'huf' | 'government'

Legal constitution of the customer. Drives which KYC documents are required.

enabledboolean

Response

Success

messagestring required

Changes

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