Partner API

Profile

Retrieve your partner identity, billing configuration, GST status, and current balance. The profile endpoint is your source of truth for your permanent partnerid — required as a filter parameter in Transaction and CDR queries.

Get Partner Profile

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

Retrieve your full partner profile including identity, balance, GST configuration, and permanent partner ID. No request body or query parameters required.

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/me" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

Python

import requests

response = requests.get(
    "https://api.vobiz.ai/api/v1/partner/me",
    headers={
        "X-Auth-ID": "{your_partner_id}",
        "X-Auth-Token": "{your_auth_token}",
        "Accept": "application/json",
    }
)

profile = response.json()
partner_id = profile["id"]  # Store this — needed for CDR/transaction queries
print(f"Partner: {profile['name']}, Balance: {profile['balance']} {profile['currency']}")

Response

200 OK

{
  "id": "partner-882abc",
  "name": "Acme Telecom",
  "email": "partner@acmetelecom.com",
  "phone": "9876543210",
  "company": "Acme Telecom Private Limited",
  "balance": 48250.00,
  "currency": "INR",
  "gstin": "27AAPFU0939F1ZV",
  "gst_status": "active",
  "tds_applicable": false,
  "tds_percentage": 0,
  "account_type": "partner",
  "status": "active",
  "created_at": "2026-01-15T10:00:00Z",
  "updated_at": "2026-03-20T09:00:00Z"
}

Response Fields

Field	Type	Description
id	string	Your permanent Partner ID. Use this in filtered CDR and transaction API queries.
name	string	Your account display name.
email	string	Login email address for your partner account.
balance	number	Current master wallet balance in the specified currency.
currency	string	Currency of your balance (e.g. INR).
gstin	string	GST Identification Number for Indian tax compliance.
gst_status	string	"active" or "inactive". Affects tax treatment on invoices.
tds_applicable	boolean	Whether Tax Deducted at Source (TDS) applies to your account.
tds_percentage	number	TDS rate applied (0 if not applicable).
status	string	"active", "suspended", or "closed".
created_at	ISO 8601	When your partner account was created.

When to Use

Initial integration setup

Call this once when your integration starts. Capture the permanent id field and store it in your system — it is needed as a filter parameter in Transaction and CDR endpoints.

Balance checks before transfers

Check your current balance before calling the Transfer Balance endpoint to ensure sufficient funds for the transfer amount.

Sync billing metadata

Sync GSTIN, TDS status, and account status to your internal billing system to ensure correct invoice generation.

Authentication

Dashboard & Analytics