Skip to main content
Clausum uses three key types. Prefixes (clm_pub_, clm_sk_, clm_wh_) identify the key class — create them in Dashboard → Connections.

​
At a glance

Publishable (browser)

Prefix: clm_pub_
Use for: Browser SDK and client-side assess.
Never for: Report fraud, payout, or merchant API.

Secret (server)

Prefix: clm_sk_
Use for: Server assess, payout, report fraud, merchant endpoints.
Never in: Browser or mobile bundles.

Webhook ingest

Prefix: clm_wh_
Use for: POST /api/webhooks/ingest only.
Not for: Assess or SDK.

​
Create keys

1

Open Connections

Sign in at sandbox.clausum.ai (or your production dashboard) → Connections.
2

Choose the tab

  • API keys → publishable or secret partner keys
  • Get started → outbound webhook URL (Outbound webhooks card)
  • Inbound (webhooks) → generic ingest key (clm_wh_*) first; optional processor guides
3

Copy once

Clausum shows the full key one time. Store it in your secrets manager immediately.
4

Set CLAUSUM_API_BASE

Use the hostname for your stage — see Access & environments.
Ingest and secret keys are not interchangeable. Assess with clm_wh_* returns 401.

​
Default permissions

Per-key rate limits are configurable when creating secret keys (rate_limit_per_minute, rate_limit_per_day).

​
Network intelligence keys

For Clausum intelligence network participation: Banks and PSPs typically use one clm_sk_* with assess + network:contribute on core middleware.
Consuming peer signals in assess requires contract CLM-ADD-NET-C — enabled by Clausum, not via key permission alone.

​
Troubleshooting

If Connections is empty after onboarding, contact api@clausum.ai with your organization name — workspace provisioning may still be in progress.

​
Next steps

Quickstart

First assess call.

Authentication

Headers, permissions, errors.