Authentication

The Partner API supports two authentication mechanisms. Header-based authentication is recommended for all programmatic integrations. JWT login is available for interactive sessions.

Overview

Every Partner API request requires your Partner credentials, obtained from the Vobiz Partner Console. There are two ways to authenticate:

Header-Based Authentication

Include the following headers on every request. These credentials are permanent and do not expire (rotate them manually if compromised).

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"

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": "Acme Corp", "email": "admin@acme.com", "password": "Secure@123", "country": "IN" }'

Partner Login (JWT)

Exchanges your email and password for a temporary JWT access token. The Postman collection automatically captures the token into partner_access_token after a successful login.

curl -X POST \
  "https://api.vobiz.ai/api/v1/partner/login" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "partner@example.com",
    "password": "YourPassword123!"
  }'

{
  "tokens": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 3600
  }
}

{
  "error": "invalid_credentials",
  "message": "The email or password you provided is incorrect."
}

Security Best Practices