> ## 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.

# Referencia de API

> Referencia interactiva de cada endpoint Clausum — OpenAPI 1.3.0

Esta referencia se genera a partir de la especificación OpenAPI de Clausum. Cada endpoint incluye un constructor de solicitudes que puedes ejecutar desde la página.

## URL base

| Stage | URL |
| - | - |
| Sandbox | `https://sandbox.clausum.ai` |
| Producción | `https://dashboard.clausum.ai` |

Tu equipo de cuenta puede asignar hostnames de API dedicados — usa solo la URL que te dieron.

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

## Autenticación

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

| Superficie | Credencial |
| - | - |
| Partner API (`/api/v1/assess`, payout, report-fraud) | `clm_sk_*` o `clm_pub_*` (solo assess) |
| Webhook ingest | `clm_wh_*` — **no** `clm_sk_*` |
| Gestión (blocklists, expedientes) | JWT de sesión del panel |

Crea claves partner en [Conexiones → Claves API](https://sandbox.clausum.ai/dashboard/integrations). Claves de ingest en **Entrada (webhooks)**.

Pega una clave secret en el campo **Authorization** del playground para probar solicitudes en vivo.

## Endpoints de descubrimiento

Sin auth requerida:

* `GET /api/v1/assess` — catálogo de campos pay-in, reglas de monto, códigos de resiliencia (versión **1.3.0**)
* `GET /api/v1/assess/payout` — catálogo de campos payout
* `GET /api/v1/health` — estado del servicio

## Grupos de endpoints

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

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

  <Card title="Fraude" icon="shield-halved">
    `POST /api/v1/report-fraud` — confirmar fraude.
  </Card>

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

  <Card title="Expedientes" icon="folder-open">
    Expedientes regulatorios — JWT del panel.
  </Card>

  <Card title="Ingest de eventos (por defecto)" icon="inbox" href="/es/guides/event-ingestion">
    `POST /api/webhooks/ingest` — `clm_wh_*` (agnóstico al procesador).
  </Card>

  <Card title="Guías por procesador (opcionales)" icon="book" href="/es/guides/stripe-webhooks">
    p. ej. adaptador nativo Stripe — secundario al ingest genérico.
  </Card>

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

  <Card title="Red de inteligencia" icon="network-wired" href="/es/guides/clausum-intelligence-network">
    `POST/GET /api/v1/network/intelligence` — publicar y consultar señales compartidas.
  </Card>
</CardGroup>

Rutas de gestión (JWT del panel, no claves partner): `/api/v1/network/membership`, `/api/v1/network/signals`, `/api/v1/submerchants`.

<Tip>
  Integradores nuevos: empieza con [Inicio rápido](/es/quickstart) y luego [Assess en tiempo real](/es/guides/realtime-assessment).
</Tip>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.