Quickstart

​

Prerequisites

• Clausum account with Dashboard access
• Connections → API keys — create a secret key (clm_sk_*) with Assess permission
• For outbound webhooks: Connections → Get started → Outbound webhooks — configure the HTTPS URL where Clausum delivers events. For inbound ingest (events you send to Clausum), use Inbound (webhooks) and create an ingest key (clm_wh_*)

​

1. Create an API key

1. Dashboard → Connections → API keys
2. Create key → type Secret → enable Assess
3. Store the key securely (shown once)

​

2. Run your first pay-in assess

curl -X POST "https://dashboard.clausum.ai/api/v1/assess" \
  -H "Authorization: Bearer clm_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-$(uuidgen)" \
  -d '{
    "amount": 45.00,
    "amount_unit": "major",
    "currency": "USD",
    "order_id": "ord_quickstart_001",
    "customer": {
      "email": "buyer@example.com",
      "ip_address": "203.0.113.10"
    },
    "device": { "fingerprint": "fp_demo_001" }
  }'

{
  "decision": "approve",
  "risk_score": 12,
  "signals": [],
  "session_id": "ps_abc123",
  "assess_flow": "payin"
}

​

3. (Optional) Payout assess

​

4. Receive webhooks

1. Connections → Inbound (webhooks) → Webhook URL
2. Subscribe to transaction.created, transaction.blocked, etc.
3. Verify X-Clausum-Signature (see Receiving webhooks)

​

5. Browser SDK (optional)

<script src="https://dashboard.clausum.ai/clausum-sdk.js"></script>
<script>
  Clausum.init({
    publishableKey: "clm_pub_...",
    apiUrl: "https://dashboard.clausum.ai"
  });
</script>

​

Next steps