Partner API Reference

Complete API reference for the Vobiz Partner Portal. Covers all 16 endpoints across 8 functional areas — authentication, customer management, billing, CDRs, and more.

New: Step-by-Step Integration Guide

Follow the complete lifecycle from account creation to trunk setup.

View Guide

Base URL & Authentication

Base URL

https://api.vobiz.ai/api/v1/partner

Required Headers — every request

X-Auth-ID

Your Partner ID

Permanent — never changes

Required

X-Auth-Token

Your secret token

Rotate if compromised

Required

Accept

application/json

All GET + POST requests

Required

No credentials yet? Contact support@vobiz.ai to enable Partner access.

API Sections

Authentication

Authenticate via X-Auth-ID + X-Auth-Token headers (recommended) or exchange email/password for a JWT session token.

POST /login

Profile

Retrieve your partner identity, balance, GST configuration, and permanent partner ID.

GET /me

Dashboard & Analytics

Live dashboard summary and date-range analytics across all customer accounts.

GET /dashboardGET /analytics

Customer Accounts

Provision sub-accounts, list and inspect customers, and check real-time wallet balances.

POST /accountsGET /accountsGET /accounts/{id}GET /accounts/{id}/balance

Balance Transfer

Fund customer wallets by transferring credits from your master partner balance.

POST /accounts/{id}/transfer-balance

Transactions

Per-customer and global financial ledgers for billing reconciliation and auditing.

GET /accounts/{id}/transactionsGET /transactions

CDRs (Call History)

Full call detail records with 10+ filters for billing, troubleshooting, and traffic monitoring.

GET /accounts/{id}/cdrsGET /accounts/{id}/cdrs/{uuid}GET /cdrs

Phone Numbers (DIDs)

View DID inventory per customer and across all accounts. Monitor assignment and expiry status.

GET /accounts/{id}/numbersGET /numbers

KYC Verification

Create, monitor, resend, and revoke KYC verification sessions utilizing Hosted KYC Widget.

POST /kyc-sessionsGET /kyc-sessionsGET /kyc-sessions/{id}DELETE /kyc-sessions/{id}

All Endpoints at a Glance

Method	Endpoint	Description	Docs
POST	/api/v1/partner/login	Partner Login (JWT)	View →
GET	/api/v1/partner/me	Get Partner Profile	View →
GET	/api/v1/partner/dashboard	Partner Dashboard summary	View →
GET	/api/v1/partner/analytics	Analytics (30d or custom range)	View →
POST	/api/v1/partner/accounts	Create Customer Account	View →
GET	/api/v1/partner/accounts	List Customer Accounts	View →
GET	/api/v1/partner/accounts/{id}	Get Customer Account	View →
GET	/api/v1/partner/accounts/{id}/balance	Get Customer Balance	View →
POST	/api/v1/partner/accounts/{id}/transfer-balance	Transfer Balance to Customer	View →
GET	/api/v1/partner/accounts/{id}/transactions	Get Customer Transactions	View →
GET	/api/v1/partner/transactions	Get All Transactions (global)	View →
GET	/api/v1/partner/accounts/{id}/cdrs	Get Customer CDRs	View →
GET	/api/v1/partner/accounts/{id}/cdrs/{uuid}	Get Specific CDR by UUID	View →
GET	/api/v1/partner/cdrs	Get All CDRs (global)	View →
GET	/api/v1/partner/accounts/{id}/numbers	Get Customer Numbers	View →
GET	/api/v1/partner/numbers	Get All Numbers (global)	View →
POST	/api/v1/partner/kyc-sessions	Create KYC Session	View →
GET	/api/v1/partner/kyc-sessions	List KYC Sessions	View →
GET	/api/v1/partner/kyc-sessions/{id}	Get KYC Session details	View →
POST	/api/v1/partner/kyc-sessions/{id}/resend	Resend KYC Email	View →
DELETE	/api/v1/partner/kyc-sessions/{id}	Revoke KYC Session	View →

Partner Overview

Authentication

Last updated: April 2026Edit this page