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

​
Base URL

Dedicated API hostnames may be assigned by your account team — use only the URL you were given.

​
Authentication

Create partner keys under Connections → API keys. Ingest keys on Inbound (webhooks). Paste a secret key into the playground Authorization field to try requests live.

​
Discoverability endpoints

No auth required:
  • GET /api/v1/assess — pay-in field catalog, amount rules, resilience codes (version 1.3.0)
  • GET /api/v1/assess/payout — payout field catalog
  • GET /api/v1/health — service status

​
Endpoint groups

Pay-in assess

POST /api/v1/assess — checkout scoring.

Payout assess

POST /api/v1/assess/payout — disbursement scoring.

Fraud

POST /api/v1/report-fraud — confirm fraud.

Blocklists

CRUD — dashboard JWT.

Cases

Regulatory cases — dashboard JWT.

Event ingest (default)

POST /api/webhooks/ingest — clm_wh_* (processor-agnostic).

Optional processor guides

e.g. Stripe native adapter — secondary to generic ingest.

Health

GET /api/v1/health.

Intelligence network

POST/GET /api/v1/network/intelligence — publish and query shared signals.
Management routes (dashboard JWT, not partner keys): /api/v1/network/membership, /api/v1/network/signals, /api/v1/submerchants.
New integrators: start with Quickstart then Real-time assessment.