Endpoint

Cash health score before your user hits a wall

One 0–100 score from the transaction stream you already have — ideal as a dashboard tile, demo, or live product review.

Turn messy bank feeds into one 0–100 cash health score in a single POST.

POST /api/v1/cashflow-health-score

What it returns

Composite 0–100 score summarizing real-time cash health — your primary conversion endpoint.

Structured fields: score, drivers.net_position_minor, drivers.monthly_outflow_minor, drivers.volatility_index

Responses always include a template-generated narrative string alongside structured — safe to show to non-technical stakeholders when you need a spoken summary.

Response shape

Every successful response includes the same top-level keys: endpoint, account_id, processing (ephemeral mode + note), structured, and narrative.

Structured subfields for this route: score, drivers.net_position_minor, drivers.monthly_outflow_minor, drivers.volatility_index

Minimal example

{
  "endpoint": "cashflow-health-score",
  "account_id": "acct_demo_001",
  "processing": {
    "mode": "ephemeral",
    "note": "Cashytics processes this request in memory only. Your payload is not stored as a ledger of record after the response is sent."
  },
  "structured": {
    "score": 74,
    "drivers": {
      "net_position_minor": 427000,
      "monthly_outflow_minor": 310000,
      "volatility_index": 0.18
    }
  },
  "narrative": "Cash health is solid. Net position covers roughly 1.4 months of outflow. Volatility is low. Main risk is the gap between current balance and the 30-day low watermark — monitor for timing mismatches."
}

Minimal curl

curl -sS -X POST "https://api.cashytics.com/api/v1/cashflow-health-score" \
  -H "Authorization: Bearer cyt_live_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d @envelope.json

Use the same envelope.json for every endpoint — add optional blocks when this route requires them.

← All endpoints