Skip to main content
This reference is generated from Clausum’s OpenAPI specification. Every endpoint includes a request builder you can run directly from the page.

​
Base URL

Partner and management endpoints share the API base URL assigned to your organization. Public documentation does not publish undisclosed production hostnames. 
# Example — sandbox trials often use:
export CLAUSUM_API_BASE="https://sandbox.clausum.ai"
The interactive playground below defaults to the sandbox host. If your contract includes a dedicated API hostname, replace the server URL in the playground with the value support gave you. See Access & environments for the full policy.

​
Authentication

Set the Authorization header on every request: 
Authorization: Bearer <key_or_token>
  • Partner API (/api/v1/assess, /api/v1/report-fraud, /api/v1/merchant/*) uses clm_sk_... or clm_pub_... (assess only). Create keys under Integraciones → API Keys.
  • Webhook ingest (/api/webhooks/ingest) uses clm_wh_... keys.
Paste a Partner key into the Authorization field of the playground to try requests live.
  • Management endpoints (/blocklists, /cases) use a dashboard session JWT.
See Authentication for the full model.

​
Endpoint groups

Risk

POST /api/v1/assess — real-time scoring and decisions.

Fraud

POST /api/v1/report-fraud — confirm fraud and trigger the chain.

Blocklists

CRUD over emails, IPs, BINs, devices, and more.

Cases

Create, update, and submit regulatory cases.

Events

POST /api/webhooks/ingest — stream raw provider events.

System

GET /api/v1/health — service status.

Dashboard

GET /api/v1/dashboard/overview — protection KPIs (session JWT).
New here? Start with Getting started in the dashboard or the Quickstart for an end-to-end walkthrough.