Admin
API Keys
Create and manage API keys
POST
Generate API keys for integrations. Only system administrators can create API keys.
Request
string
required
Bearer <token> - System Admin JWTBody 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
Errors
Authorizations
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Body
application/json
API key details
Response
API key created
The response is of type object.