Users and Jurisdictions

Endpoints for retrieving users within your organization and the list of supported jurisdictions.

Returns your workspace users.

get

https://demo-api.vivox.aihttps://portal-api.vivox.ai

/v1/users

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

application/json

Lightweight user representation.

idstring · uuidRequired

The user's unique identifier.

Example: 00a68114-e5e4-48bc-af16-bed68f2f1550

namestringRequiredExample: Jane Doe

emailstring · emailRequiredExample: [email protected]

401

Not authenticated

application/json

get

/v1/users

HTTPcURLJavaScriptPython

GET /v1/users HTTP/1.1
Host: demo-api.vivox.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "00a68114-e5e4-48bc-af16-bed68f2f1550",
    "name": "Jane Doe",
    "email": "[email protected]"
  },
  {
    "id": "954d25a4-0ec5-454e-8899-577dec5815c6",
    "name": "John Smith",
    "email": "[email protected]"
  }
]

Return the list of jurisdictions available for KYB processes.

get

https://demo-api.vivox.aihttps://portal-api.vivox.ai

/v1/jurisdictions

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

application/json

code_isostring · min: 2 · max: 2OptionalExample: CN

namestringOptionalExample: China

supports_autosearchbooleanOptionalExample: false

401

Not authenticated

application/json

get

/v1/jurisdictions

HTTPcURLJavaScriptPython

GET /v1/jurisdictions HTTP/1.1
Host: demo-api.vivox.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "code_iso": "CN",
    "name": "China",
    "supports_autosearch": false
  },
  {
    "code_iso": "US",
    "name": "United States",
    "supports_autosearch": false
  }
]