---
title: "Create a sub-account"
method: POST
path: "/api/v1/accounts/{auth_id}/sub-accounts/"
tags: ["Sub-Accounts"]
---

# Create a sub-account

`POST /api/v1/accounts/{auth_id}/sub-accounts/`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/`
- Auth: API key in header `X-Auth-ID` and API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/accounts/:auth_id/sub-accounts/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `auth_id` string, required

## Request body

- object
  - `name` string, required: Human-readable name for the sub-account.
  - `email` string, email: Required when `kyc_mode` is `customer_use`.
  - `password` string: 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.
  - `enabled` boolean

## Response `200`

Success

- object
  - `message` string, required
  - `sub_account` object, required
    - `name` string, required
    - `email` unknown, required
    - `phone` unknown, required
    - `description` unknown, required
    - `permissions` unknown, required
    - `rate_limit` integer, required
    - `id` string, required
    - `parent_account_id` string, required
    - `parent_auth_id` string, required
    - `auth_id` string, required
    - `auth_token` string, required
    - `api_id` string, required
    - `email_verified` boolean, required
    - `enabled` boolean, required
    - `created` string, required
    - `modified` string, required
    - `is_active` boolean, required
    - `created_at` string, required
    - `updated_at` string, required
    - `last_used` unknown, required
    - `account` string, required
    - `resource_uri` string, required
  - `auth_credentials` object, required
    - `auth_id` string, required
    - `auth_token` string, required
  - `tokens` object, required
    - `access_token` string, required
    - `refresh_token` string, required
    - `token_type` string, required
    - `expires_in` integer, required

## Other responses

- `201`: Sub-account created

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) - [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vobiz/apis/vobiz-api/revisions/863f08cd6737?raw)