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

# Assessment explainability package

> Returns a structured explainability package (signals, network hits, block provenance, outcomes) for a payment session. Requires secret key with `transactions:read` or `stats:read`. Use `?format=csv` for CSV export.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/merchant/assess-sessions/{sessionId}/explainability
openapi: 3.1.0
info:
  title: Clausum API
  version: 1.4.0
  description: >-
    REST API for real-time fraud risk assessment (pay-in and payout), fraud
    reporting, blocklist management, and event ingestion. API version 1.3.0.
    Create Partner API keys (`clm_pub_*`, `clm_sk_*`) in the dashboard under
    Conexiones → Claves API. Webhook ingest uses separate `clm_wh_*` keys
    (Conexiones → Entrada webhooks).
  contact:
    name: Clausum API Support
    email: api@clausum.ai
    url: https://clausum.ai
servers:
  - url: https://sandbox.clausum.ai
    description: Sandbox — integrators and trials
  - url: https://dashboard.clausum.ai
    description: Production dashboard and Partner API
security:
  - apiKeyAuth: []
tags:
  - name: Risk
    description: Real-time risk scoring for pay-in checkout and sessions.
  - name: Payout
    description: Outbound disbursement and treasury transfer assessment.
  - name: Fraud
    description: Report confirmed fraud and trigger the downstream chain.
  - name: Network
    description: >-
      Collaborative fraud intelligence — publish and query shared signals
      between opt-in participants.
  - name: Blocklists
    description: Manage dynamic blocklists used during assessment.
  - name: Cases
    description: Manage fraud cases (expedientes) and submit them to regulators.
  - name: Events
    description: Ingest raw events from your payment providers.
  - name: System
    description: Health and status checks.
  - name: PSP Submerchants
    description: >-
      PSP submerchant registry and scoped API keys (requires
      submerchants:read/write).
  - name: Merchant
    description: Partner merchant API — stats, cases, prevention KPIs, explainability.
paths:
  /api/v1/merchant/assess-sessions/{sessionId}/explainability:
    get:
      tags:
        - Merchant
      summary: Assessment explainability package
      description: >-
        Returns a structured explainability package (signals, network hits,
        block provenance, outcomes) for a payment session. Requires secret key
        with `transactions:read` or `stats:read`. Use `?format=csv` for CSV
        export.
      operationId: merchantAssessExplainability
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
        - name: format
          in: query
          schema:
            type: string
            enum:
              - csv
      responses:
        '200':
          description: Explainability package (JSON or CSV)
        '404':
          description: Session not found
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Partner secret or publishable key, e.g. `clm_sk_...` or `clm_pub_...`
        (assess only).
      x-default: clm_sk_your_secret_key

````

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