Skip to main content
The Subaccount object represents an isolated account under your main Vobiz account, with its own authentication credentials, permissions, and rate-limiting configuration.

​
Attributes

FieldTypeDescription
idstringNumeric internal identifier for the sub-account (e.g., "500001"). This is not the auth_id — use auth_id for API calls.
namestringName of the sub-account.
descriptionstring | nullDescription of the sub-account purpose or usage.
permissionsobjectPermissions object defining what the sub-account can access. Contains boolean fields like calls and cdr.
rate_limitintegerAPI rate limit for this sub-account (requests per time period).
kyc_modestringVerification mode: personal_use (inherits parent KYC) or customer_use (the sub-account must complete its own KYC).
business_typestring | nullLegal constitution of the customer (e.g. individual, private_limited, llp). Drives which KYC documents are required.
kyc_calls_blockedbooleantrue while a customer_use sub-account has not yet completed the KYC required to place calls.
parent_account_idstringNumeric ID of the parent main account (e.g., "510762").
parent_auth_idstringAuth ID of the parent main account (e.g., "MA_XXXXXXXX").
auth_idstringThe sub-account’s own Auth ID (SA_…). Use this as the X-Auth-ID for the sub-account’s runtime calls, and as the {sub_auth_id} path segment elsewhere.
auth_tokenstringThe sub-account’s Auth Token. Returned in clear text only once, at creation; masked (<redacted>) on every later read.
email_verifiedbooleanWhether the sub-account’s email has been verified.
enabledbooleanWhether the sub-account is enabled. A disabled sub-account stops accepting traffic but keeps its numbers.
is_activebooleanWhether the sub-account is currently active and can make API calls.
created_atstringISO 8601 timestamp when the sub-account was created.
updated_atstringISO 8601 timestamp when the sub-account was last updated.
last_usedstring | nullISO 8601 timestamp when the sub-account was last used for API calls. Null if never used.

​
Example Subaccount Object

{
  "name": "Support Team",
  "description": "Support-facing voice workload",
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "rate_limit": 500,
  "kyc_mode": "customer_use",
  "business_type": "private_limited",
  "kyc_calls_blocked": true,
  "id": "500001",
  "parent_account_id": "510762",
  "parent_auth_id": "MA_XXXXXXXX",
  "auth_id": "SA_XXXXXXXX",
  "auth_token": "<redacted>",
  "email_verified": false,
  "enabled": true,
  "is_active": true,
  "created_at": "2025-10-22T03:57:35.997500Z",
  "updated_at": "2025-10-22T03:57:35.997500Z",
  "last_used": null
}
Permissions Object: The permissions object controls what resources the sub-account can access:
  • calls - Whether the sub-account can make/receive calls
  • cdr - Whether the sub-account can access Call Detail Records
Rate Limiting: The rate_limit field controls API request throttling for this sub-account. Set this based on expected usage patterns to prevent abuse.
KYC mode: customer_use sub-accounts must complete their own KYC before placing calls — they’re created with kyc_calls_blocked: true. See Sub-Account KYC.