Axiom Platform API (0.2.126)
Axiom is programmable insurance infrastructure: one engine for every line of insurance, where the rules are data and every decision can be explained to the person it affects.
Axiom provides a complete REST API across the five universal insurance primitives — parties/roles, covers/products, policies/versions, premiums/payments, and events/assertions (under the governed contract). Every feature is designed API-first under the governed contract.
All API requests (except health checks) require:
- Bearer token via
Authorizationheader (JWT from auth service) - Tenant context via
X-Tenant-Contextheader (server-minted token, required on tenant-scoped endpoints)
Most endpoints currently return a legacy envelope format:
{
"data": { ... },
"status": "success",
"message": "optional description"
}
Error responses:
{
"error": "Human-readable error message",
"status": "error"
}
Newer endpoints (inbox, ingress, webhooks, vendors) use the JSON:API format under the governed contract. Migration of legacy endpoints to JSON:API is planned.
List endpoints declare their pagination profile per operation. Converged public and application-visible list endpoints use cursor-based pagination:
page[size]— maximum items per pagepage[after]— opaque cursor from the previous pagepage[before]— opaque cursor for reverse traversal, only where the operation explicitly documents support
Cursor response metadata includes has_more, next_cursor, and may include prev_cursor where reverse traversal is supported.
Example cursor metadata:
{
"data": [...],
"meta": { "has_more": true, "next_cursor": "opaque-token" },
"status": "success"
}
Include X-Correlation-ID header for end-to-end request tracing. If omitted, the server generates one. The response always includes X-Correlation-ID for support reference.
API families are in the URL path (/v1/...). The published contract version is SemVer and is emitted in info.version, X-API-Version, and response telemetry under the governed contract.
When a tenant-scoped route has an active runtime rate-limit policy, responses include budget headers:
X-RateLimit-Limit— active tenant policy limit for the routeX-RateLimit-Remaining— remaining requests in the current windowX-RateLimit-Reset— window reset time (Unix timestamp)
Rejected calls return 429 with Retry-After.