Authentication
Every Partner API request requires an HTTP Bearer token issued for your application and environment.
How to use
- Create an application in Developers and copy the sandbox key (shown once).
- Send
Authorization: Bearer knos_sandbox_…(orknos_production_…after Ops approval) on every request. - Grant only the scopes you need; missing scope →
FORBIDDEN.
Bearer token
HTTP header
Authorization: Bearer knos_sandbox_<secret># orAuthorization: Bearer knos_production_<secret>| Prefix | Environment | Fulfillment |
|---|---|---|
knos_sandbox_ | Sandbox | Simulated — sandbox fulfillment only (not live providers) |
knos_production_ | Production | Live providers via KNOS (Ops-approved app) |
Scopes
Keys are limited to the scopes granted on the application. Missing scope → FORBIDDEN / unauthorized response.
| Scope | Used by |
|---|---|
products:read | GET /products |
balance:read | GET /balance |
transactions:create | POST /transactions |
transactions:read | GET /transactions/{id} |
webhooks:manage | POST /webhooks/test |
meters:lookup | POST /meters/lookup |
numbers:verify | POST /numbers/verifications |
airtime:purchase | Airtime create |
data:purchase | Data create |
voice:purchase | Voice create |
afa:purchase | AFA create |
ecg:purchase | ECG create |
Unauthorized example
GET https://confident-elephant-309.convex.site/v1/products (no auth)
{ "code": "UNAUTHORIZED", "message": "Missing or invalid Authorization Bearer token"}IP allowlist
Optional per environment on the application. When configured, requests from other IPs are rejected. Configure in the Developer portal.