> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clausum.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Interactive reference for every Clausum endpoint — OpenAPI 1.3.0

This reference is generated from Clausum's OpenAPI specification. Each endpoint includes a request builder you can run from the page.

## Base URL

| Stage      | URL                            |
| ---------- | ------------------------------ |
| Sandbox    | `https://sandbox.clausum.ai`   |
| Production | `https://dashboard.clausum.ai` |

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

```bash theme={null}
export CLAUSUM_API_BASE="https://sandbox.clausum.ai"
```

## Authentication

```bash theme={null}
Authorization: Bearer <key_or_token>
```

| Surface                                              | Credential                              |
| ---------------------------------------------------- | --------------------------------------- |
| Partner API (`/api/v1/assess`, payout, report-fraud) | `clm_sk_*` or `clm_pub_*` (assess only) |
| Webhook ingest                                       | `clm_wh_*` — **not** `clm_sk_*`         |
| Management (blocklists, cases)                       | Dashboard session JWT                   |

Create partner keys under [Conexiones → Claves API](https://sandbox.clausum.ai/dashboard/integrations). Ingest keys on **Entrada (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

<CardGroup cols={2}>
  <Card title="Pay-in assess" icon="gauge-high">
    `POST /api/v1/assess` — checkout scoring.
  </Card>

  <Card title="Payout assess" icon="money-bill-transfer">
    `POST /api/v1/assess/payout` — disbursement scoring.
  </Card>

  <Card title="Fraud" icon="shield-halved">
    `POST /api/v1/report-fraud` — confirm fraud.
  </Card>

  <Card title="Blocklists" icon="ban">
    CRUD — dashboard JWT.
  </Card>

  <Card title="Cases" icon="folder-open">
    Regulatory expedientes — dashboard JWT.
  </Card>

  <Card title="Ingest" icon="inbox">
    `POST /api/webhooks/ingest` — `clm_wh_*` only.
  </Card>

  <Card title="Stripe" icon="stripe" href="/guides/stripe-webhooks">
    `POST /api/webhooks/stripe` — provider adapter.
  </Card>

  <Card title="Health" icon="heart-pulse">
    `GET /api/v1/health`.
  </Card>
</CardGroup>

<Tip>
  New integrators: start with [Quickstart](/quickstart) then [Real-time assessment](/guides/realtime-assessment).
</Tip>