End-to-end integration flow
Follow the complete lifecycle from account creation to trunk setup.
Base URL & Authentication
All Partner API endpoints share a single base URL:X-Auth-ID and X-Auth-Token. See Authentication for full details.
Do not have credentials yet? Contact support@vobiz.ai to enable Partner access.
API Sections
Authentication
Header-based credentials and JWT login.
Profile
Identity, balance, and GST configuration.
Dashboard & Analytics
Live metrics and date-range performance reporting.
Customer Accounts
Provision sub-accounts under your partner umbrella.
Balance Transfer
Move credit from your master wallet to customers.
KYC Sessions
Initiate and manage customer KYC verification.
Transactions
Per-customer and global financial ledgers.
CDRs
Call detail records for billing and troubleshooting.
Phone Numbers
DID inventory across all customer accounts.
All Endpoints at a Glance
| Method | Endpoint | Description | Docs |
|---|---|---|---|
| POST | /login | Exchange email/password for JWT access token | Auth |
| GET | /me | Retrieve partner profile and balance | Profile |
| GET | /dashboard | Live partner dashboard summary | Analytics |
| GET | /analytics | Date-range aggregated call analytics | Analytics |
| POST | /accounts | Create a customer sub-account | Customers |
| GET | /accounts | List all customer accounts | Customers |
| GET | /accounts/{customer_auth_id} | Get customer profile | Customers |
| GET | /accounts/{customer_auth_id}/balance | Get customer wallet balance | Customers |
| POST | /accounts/{customer_auth_id}/transfer-balance | Transfer credit to a customer | Balance |
| POST | /kyc-sessions | Initiate KYC for a sub-account | KYC |
| GET | /kyc-sessions | List KYC sessions (paginated) | KYC |
| GET | /kyc-sessions/{session_id} | Get a KYC session by ID | KYC |
| POST | /kyc-sessions/{session_id}/resend | Resend the KYC email | KYC |
| DELETE | /kyc-sessions/{session_id} | Revoke a KYC session | KYC |
| GET | /accounts/{customer_auth_id}/transactions | Customer transaction ledger | Transactions |
| GET | /transactions | Global transaction ledger | Transactions |
| GET | /accounts/{customer_auth_id}/cdrs | Customer CDR list | CDRs |
| GET | /accounts/{customer_auth_id}/cdrs/{call_uuid} | Single CDR by UUID | CDRs |
| GET | /cdrs | Global CDR list | CDRs |
| GET | /accounts/{customer_auth_id}/numbers | Numbers assigned to a customer | Numbers |
| GET | /numbers | Global number inventory | Numbers |