Skip to main content
Clausum intelligence combines two layers that apply during POST /api/v1/assess and POST /api/v1/assess/payout:
The network augments assess — it does not replace your local rules, blocklists, or the synchronous assess call. Prevention first.

Who this guide is for

Segment plans: Bank · PSP · Merchant

How it fits your stack


Quick start — bank (5 steps)

1

1. Create a server key

Dashboard → Conexiones → Claves API — create clm_sk_* with:
  • assess — required to benefit from consumed signals
  • network:contribute — publish signals (or fraud:report for single reports)
See API keys.
2

2. Enable contribution

Banks use profile financial_institution. Contribution is toggled in the dashboard:
  • Inteligencia (/dashboard/network) → Inicio rápido panel (banks only) or Configuración tab → enable Contribuir a la red
Consuming peer signals in assess is enabled by Clausum on your contract (CLM-ADD-NET-C). Contact your account manager — it is not self-serve via API.
3

3. Publish signals

Send confirmed fraud indicators from your core or fraud platform (up to 500 entries per request):
4

4. Protect pay-in and payout

Every payment or disbursement should call assess before money moves:When network consume is active, assess matches normalized fields against peer signals from contributors whose trust score meets your threshold.
5

5. Operate and revoke

  • Inteligencia → Mis señales — review and revoke false positives
  • Inteligencia → Participantes — see contributing institutions (when consume is on)
  • Protección — compact status for managed + network layers

Quick start — PSP (5 steps)

1

1. Complete PSP onboarding

Register sub-merchants before live assess — PSP submerchants. Every pay-in assess must include submerchant_id when your registry is non-empty.
2

2. Create middleware keys

clm_sk_* on your PSP orchestration layer with assess + optional network:contribute. Never embed secret keys in sub-merchant frontends.
3

3. Assess before settlement

Your middleware enforces decision before settling funds to the sub-merchant. See PSP integration.
4

4. Optionally contribute aggregated signals

Publish BIN ranges, emails, or IPs observed across your portfolio (with legal approval):
Enable Contribuir in Inteligencia → Configuración.
5

5. Route webhooks per sub-merchant

Outbound events include metadata for routing — Receiving webhooks. Pipe acquirer events via Event ingestion as a complement to assess.

API reference

Publish signals

Permissions: network:contribute or fraud:report (secret key only). Body: entries[] (max 500) or single list_type + value. Response:
Errors:

Network stats (partner)

Permissions: network:signals:read, network:contribute, fraud:report, or assess. Returns your membership snapshot, contributed active count, and network pool size.

Dashboard membership (session)

Authenticated with dashboard session (browser cookie after sign-in), not partner keys. Tenants may PATCH contribute_enabled only. consume_enabled and integration_profile are managed by Clausum based on organization type and contract.

Revoke signals (dashboard session)

Sets is_active = false for your organization’s entry. Also available in Inteligencia → Mis señales.

Supported signal types

Severity behavior: a peer signal with block can force decline during assess, similar to a local blocklist hit.

Privacy and compliance

Before contributing:
  • Confirm your legal / compliance team approves sharing each signal class
  • Document internal case IDs in reason_detail — not exposed to other tenants
  • Maintain a runbook to revoke false positives via Mis señales

Trust and consumption

Each contributor has a trust score (0–100). When consume is enabled, assess applies signals only from contributors at or above your organization’s minimum trust threshold (configured by Clausum). Dashboard Participantes lists institutions with active contributions and whether they meet your threshold.

Bank integration patterns

Core banking / SPEI

Call assess synchronously in the authorization path before releasing funds:
  1. Core receives transfer request
  2. Middleware calls POST /api/v1/assess/payout
  3. On decline → hold transfer, open case
  4. On approve / review → follow your policy matrix (Assess resilience)
Pair with payout blocklists (flow_scope: payout) — Blocklists.

Fraud feed batch jobs

Schedule nightly or hourly jobs from your fraud warehouse:
  • Map internal tables → entries[]
  • Use stable external_ref per row for idempotent updates
  • Start with severity: review in UAT; promote to block after validation

Cases and regulatory workflow

Link high-severity network hits to Case management. Report fraud can complement bulk API for ad-hoc confirmations.

PSP integration patterns

Middleware owns orchestration

Clausum does not call Stripe, Mercado Pago, or your acquirer. Your PSP layer:
  1. Receives payment attempt from sub-merchant checkout
  2. Calls assess with submerchant_id
  3. Branches on decision before capture
See architecture diagram in PSP integration.

Multi-tenant signal contribution

When contributing portfolio-level signals:
  • Avoid sub-merchant PII in reason_detail
  • Prefer BIN, IP, and velocity patterns over raw emails when possible
  • Separate sandbox and production keys per environment

Institutional add-ons

PSPs with treasury or disbursement products should also evaluate Payout assessment and Regulatory screening when on CLM-MOD-INST.

Managed feeds (CLM-ADD-INTEL)

When entitled, Clausum-operated threat feeds apply automatically during assess — no API setup. Check status in Dashboard → Protección (Inteligencia Clausum strip). Staff syncs feeds on the platform side; tenants see signal counts and last sync time only. This layer is independent of the collaborative network — you may have one, both, or neither depending on contract.

Go-live checklists

Bank

  • Server key with assess + network:contribute
  • Contribution enabled in Inteligencia → Configuración
  • CLM-ADD-NET-C confirmed with account manager if consuming peer signals
  • Payout assess wired before SPEI/wire release (Bank integration)
  • UAT: publish test signal from staging org → verify assess match
  • Runbook for revoking false positives in Mis señales
  • Certification sign-off on cert.clausum.ai when provided

PSP

  • All active sub-merchants registered with stable external_id
  • Every assess includes submerchant_id when registry is non-empty
  • Middleware enforces decision before acquirer capture
  • Optional: contribution enabled + legal sign-off for aggregated signals
  • Webhook routing tested per sub-merchant
  • Sandbox UAT on sandbox.clausum.ai before production

Troubleshooting


Bank integration

Payout-first institutional plan

PSP integration

Sub-merchant routing plan

Real-time assess

Pay-in API

Payout assess

Disbursement API

API keys

Permissions and prefixes

Capabilities

Module catalog by segment
Support: api@clausum.ai