Vobiz Sub-Accounts API – Multi-Tenant & Reseller Account Management

Subaccounts let you manage multiple customer accounts under a single parent Account. Use them to segment, manage, and track each user’s usage independently.

Base URI

https://api.vobiz.ai/api/v1/Account/{auth_id}/Subaccount/

Key features

Complete resource isolation with dedicated auth credentials for secure multi-tenancy
Independent management of trunks, numbers, CDRs, and balances per subaccount
Parent account retains full administrative control over all subaccount operations
Each subaccount receives unique auth_id and auth_token for API access

Subaccount Operations

The Subaccount Object

View the structure and attributes of the Subaccount object including auth credentials, enabled status, and resource URI.

Create a Subaccount

POST request to create a new subaccount with a name and enabled status. Returns unique auth credentials.

Retrieve a Subaccount

GET request to retrieve details of a specific subaccount including auth credentials and settings.

Update a Subaccount

PUT request to update subaccount name or enabled status. Disabling blocks all API calls and trunk usage.

Delete a Subaccount

DELETE request to permanently remove a subaccount. Optionally cascade delete or reassociate resources.

List All Subaccounts

GET request to retrieve all subaccounts with pagination support. Sorted by creation date.

Sub-Account KYC

Verify customer_use sub-accounts via the per-document API (PAN, GST, CIN, DigiLocker) or a hosted KYC session.

Customer KYC (`kyc_mode`)

A sub-account’s kyc_mode decides whether it needs its own verification:

`kyc_mode`	KYC required?	Use it for
`personal_use` (default)	No — inherits the parent account’s KYC.	Internal departments, dev/staging, your own workloads.
`customer_use`	Yes — the sub-account must verify itself before placing calls. Requires `email`.	Reseller customers and multi-tenant SaaS end-customers who must be KYC’d in their own name.

A fresh customer_use sub-account is returned with kyc_calls_blocked: true and stays call-blocked until KYC completes. Drive verification with the Sub-Account KYC API — either per-document or via a hosted session — and build against it risk-free using Test Mode.

Subaccount Use Cases

Multi-Tenant SaaS

Create a subaccount for each customer. Each customer gets isolated resources and its own API credentials for programmatic access.

Department Isolation

Create subaccounts for different departments (Sales, Support, Operations). Each department gets its own trunks and phone numbers.

Reseller Model

Create subaccounts for resellers who manage their own customers. Track usage and billing separately per subaccount.

Development/Staging

Create subaccounts for dev, staging, and production environments. Test changes in isolation without affecting production.