Welcome to Vivox API

The Vivox API is organized around REST principles. It uses standard HTTP response codes, authentication, and verbs.

Base URLs

Sandbox Environment:

https://demo-api.vivox.ai/v1

Production Environment:

https://portal-api.vivox.ai/v1

Authentication

The Vivox API uses token-based authentication. Tokens do not expire automatically and can only be invalidated by manually revoking them. You can view and manage your API keys in the Vivox Dashboard (you must be an organization admin):

• Sandbox: https://demo.vivox.ai/settings/apikeys

• Production: https://portal.vivox.ai/settings/apikeys

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail

Once you have an API token, you need to include it in the Authorization header of each API request. The token should be prefixed with the word Bearer, followed by a space. Here's an example of how the Authorization header should look:

Authorization: Bearer YourAPITokenHere

When making requests to the API, ensure that the Authorization header with your API token is included in each request. Without this header the API will respond with an authentication error.

Here’s a sample cURL request to the API with an API token:

curl -X GET \
     -H "Authorization: Bearer YourAPITokenHere" \
     -H "Accept: application/json" \
     "https://demo-api.vivox.ai/v1/users"

Quick Start: Create Your First KYB Case

Once you have your API token, you can create your first KYB case.

curl --request POST \
  --url "https://demo-api.vivox.ai/v1/kyb-cases" \
  --header "Authorization: Bearer YOUR_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "legal_name": "Acme Corporation Ltd",
    "jurisdiction_code": "US",
    "reference_id": "CRM-001234"
  }'