Partner API

Customer Accounts

The core of the Partner API — provision SIP-enabled sub-accounts for your clients, inspect their profiles, and monitor their real-time wallet balances. Each customer gets an auth_id that is the primary key for all subsequent operations.

Overview

Method	Endpoint	Description
POST	/accounts	Create a new customer account
GET	/accounts?page=1&size=20	List all customer accounts (paginated)
GET	/accounts/{customer_auth_id}	Get a specific customer's full profile
GET	/accounts/{customer_auth_id}/balance	Get real-time wallet balance

Create Customer Account

POSThttps://api.vobiz.ai/api/v1/partner/accounts

Provisions a new SIP-enabled Vobiz account under your partner umbrella. The customer is created instantly and can start receiving calls as soon as you assign them a phone number and fund their wallet.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Content-Type: application/json

Request Body

Field	Type	Required	Description
name	string	Required	Customer display name
email	string	Required	Login email for the customer account
password	string	Required	Initial password. Min 8 chars, must include a special character and number.
phone	string	Required	Contact phone number for the account
country	string	Required	ISO country code (e.g. IN, US, GB)
description	string	Optional	Internal notes about this customer
company	string	Optional	Legal company / business name
address	string	Optional	Street address
city	string	Optional	City
state	string	Optional	State or province
zip_code	string	Optional	Postal or ZIP code
timezone	string	Optional	IANA timezone string (e.g. Asia/Kolkata)
gstin	string	Optional	GST Identification Number (India only)
gst_status	string	Optional	"active" or "inactive"
account_type	string	Optional	Account tier. Default: "standard"

cURL

curl -X POST \
  "https://api.vobiz.ai/api/v1/partner/accounts" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Credresolve",
    "email": "admin@credresolve.com",
    "password": "SecurePass@123",
    "phone": "9431538535",
    "description": "Outbound collections calling team",
    "company": "Credresolve Private Limited",
    "address": "123 Brigade Road",
    "city": "Bangalore",
    "state": "Karnataka",
    "zip_code": "560001",
    "country": "IN",
    "timezone": "Asia/Kolkata",
    "gstin": "29AAPFU0939F1ZV",
    "gst_status": "active",
    "account_type": "standard"
  }'

Response

201 Created

{
  "auth_id": "MA_48149cf4",
  "name": "Credresolve",
  "email": "admin@credresolve.com",
  "status": "active",
  "balance": 0.00,
  "currency": "INR",
  "country": "IN",
  "timezone": "Asia/Kolkata",
  "created_at": "2026-03-25T10:00:00Z"
}

Store the auth_id immediately. The returned auth_id is the customer's permanent identifier for all balance transfers, CDR lookups, transaction queries, and number assignments. Save it to your database as the primary foreign key.

List Customer Accounts

GEThttps://api.vobiz.ai/api/v1/partner/accounts

Returns all customer accounts under your partner umbrella in a paginated list. Use search to find a specific customer by name or email.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

Query Parameters

Param	Default	Description
page	1	Page number
size	20	Records per page (max 100)
search	(empty)	Search by customer name or email

cURL — List all accounts

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts?page=1&size=20" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

cURL — Search by name

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts?page=1&size=20&search=Credresolve" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "data": [
    {
      "auth_id": "MA_48149cf4",
      "name": "Credresolve",
      "email": "admin@credresolve.com",
      "status": "active",
      "balance": 2450.00,
      "currency": "INR",
      "created_at": "2026-03-01T10:00:00Z"
    }
  ],
  "meta": {
    "total": 47,
    "page": 1,
    "size": 20,
    "total_pages": 3
  }
}

Get Customer Account

GEThttps://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}

Returns the full technical profile for a specific customer including their auth token (required to make API calls on their behalf), billing configuration, GST details, and current status.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "auth_id": "MA_48149cf4",
  "auth_token": "sk_live_customer_token_here",
  "name": "Credresolve",
  "email": "admin@credresolve.com",
  "phone": "9431538535",
  "company": "Credresolve Private Limited",
  "status": "active",
  "balance": 2450.00,
  "currency": "INR",
  "gstin": "29AAPFU0939F1ZV",
  "gst_status": "active",
  "country": "IN",
  "timezone": "Asia/Kolkata",
  "created_at": "2026-03-01T10:00:00Z"
}

Get Customer Balance

GEThttps://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/balance

Returns the real-time wallet balance for a specific customer. Use this before deciding whether to top up a customer's wallet. A customer with zero or near-zero balance will start experiencing call failures.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/balance" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "auth_id": "MA_48149cf4",
  "name": "Credresolve",
  "balance": 2450.00,
  "currency": "INR",
  "last_updated": "2026-03-25T09:55:32Z"
}

Provisioning Workflow

Follow this sequence when onboarding a new customer:

Create the accountPOST /accounts

Provision the sub-account. Store the returned auth_id in your database.

Fund the walletPOST /accounts/{id}/transfer-balance

Transfer opening balance from your master account. Customer cannot make calls without balance.

Assign phone numbersVobiz Console or Numbers API

Assign one or more DID phone numbers to the customer account. Customers need a DID to receive inbound calls.

Monitor usageGET /accounts/{id}/cdrs

Pull CDRs and transaction logs regularly for billing and quality monitoring.

Dashboard & Analytics

Balance Transfer