Skip to main content
POST
Generate API keys for integrations. Only system administrators can create API keys.

Request

string
required
Bearer <token> - System Admin JWT

Body Parameters

string
required
Friendly name for the API key
array
Permission scopes for the key (e.g., ["payments:read", "balance:read"])
string
Expiration date (ISO 8601). Leave empty for no expiration.

Response

string
The generated API key (shown only once)
string
Key name
array
Assigned permission scopes
string
Creation timestamp
string
Expiration timestamp (if set)

Examples


Available Scopes


Security

The API key is only shown once at creation. Store it securely immediately.
  • API keys should be rotated periodically
  • Use the minimum required scopes
  • Set expiration dates for temporary integrations

Errors

Authorizations

Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Body

application/json

API key details

name
string
required
scopes
string[]
required
Minimum array length: 1
description
string
expires_in_days
integer
integration_type
string

whatsapp, smart_pay, vult, agent_app

ip_whitelist
string[]
rate_limit
integer

Response

API key created

The response is of type object.