A REST API for contacts, broadcasts, compliance, and dialer operations. JWT-authenticated. Rate-limited. JSON in and out. The full endpoint reference and request shapes are provisioned when your API key is issued.
Every request is authenticated with a JWT bearer token issued when your account is provisioned. All POST bodies are application/json. Responses are always JSON. Rate limits apply across the API and tighten on AI-driven and compliance endpoints.
Three example shapes — write, read, check. Your provisioning bundle includes the full endpoint list, request schemas, and rate-limit caps specific to your account.
Submit a job. The API queues it, runs pre-flight checks, and returns a handle for status polling.
$ curl -X POST https://api.fivrasms.com/v1/… \ -H "Authorization: Bearer $YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d @request.json # 200 OK { "id": "...", "status": "queued", "createdAt": "2026-05-29T14:02:00Z" }
Read a resource or job status. Idempotent. Useful for polling progress on long-running operations.
$ curl https://api.fivrasms.com/v1/…/{id} \ -H "Authorization: Bearer $YOUR_API_KEY" # 200 OK { "id": "...", "status": "complete", "updatedAt": "2026-05-29T14:05:11Z" }
Synchronous compliance check. Pass input, get a verdict back in a single request — no queuing.
$ curl -X POST https://api.fivrasms.com/v1/…/check \ -H "Authorization: Bearer $YOUR_API_KEY" \ -d @input.json # 200 OK { "ok": true, "checkedAt": "2026-05-29T14:02:00Z" }
Specific endpoints, schemas, rate-limit caps, and webhook payloads are provisioned when your API key is issued. Talk to us about your use case and we'll get you on the platform.
Or a webhook to receive events? Get in touch — we'll provision an API key and walk through the endpoints you need.
