Skip to main content

Reference

Business Intelligence

Enterprise only

Composite business health score (0–1000), detailed health analysis, cross-sell signals, churn risk, and cash-flow forecasts.

The intelligence module surfaces a composite Business Score (0–1000) and derived insights — cross-sell signals, churn risk, and cash-flow forecasts — computed from real-time journal entries. It's the same engine that feeds the account officer portal and branch analytics.

Business Score

GET/v1/businesses/{businessId}/intelligence/health-score

Returns the composite business score (0–1000) with weighted category breakdown and 6-month history.

Response — 200

{
  "success": true,
  "data": {
    "businessId": "biz_001",
    "score": 780,
    "maxScore": 1000,
    "status": "green",
    "computedAt": "2026-04-17T10:30:00.000Z",
    "breakdown": {
      "revenueTrend": { "score": 85, "weight": 25, "detail": "+7.1% growth over 3 months" },
      "cashPosition": { "score": 78, "weight": 20, "detail": "4.3 months runway" },
      "receivablesQuality": { "score": 82, "weight": 15, "detail": "88% current, 8% overdue" },
      "expenseManagement": { "score": 75, "weight": 15, "detail": "62% expense-to-revenue ratio" },
      "debtHealth": { "score": 90, "weight": 10, "detail": "0.3x debt-to-equity" },
      "taxCompliance": { "score": 100, "weight": 10, "detail": "All filings current" },
      "platformEngagement": { "score": 95, "weight": 5, "detail": "Active daily, 100% feature adoption" }
    },
    "previousScore": 760,
    "scoreHistory": [
      { "date": "2025-11-17", "score": 735 },
      { "date": "2025-12-17", "score": 745 },
      { "date": "2026-01-17", "score": 750 },
      { "date": "2026-02-17", "score": 760 },
      { "date": "2026-03-17", "score": 770 },
      { "date": "2026-04-17", "score": 780 }
    ]
  }
}

Score bands

BandRangeMeaning
green750–1000Healthy
amber500–749Warning
red0–499Critical

Detailed health analysis

GET/v1/businesses/{businessId}/intelligence/health-analysis

Narrative health analysis with revenue and cash-flow history plus driver breakdowns.

Returns a headline, commentary, drivers[] (label, value, trend, sentiment), 6-month revenueHistory, and 6-month cashFlowHistory. Use this for dashboards that need both the number and the story behind it.

Cross-sell signals

GET/v1/businesses/{businessId}/intelligence/cross-sell-signals

AI-detected cross-sell opportunities derived from transaction patterns.

Response — 200

{
  "success": true,
  "data": {
    "businessId": "biz_001",
    "signals": [
      {
        "signalId": "sig_001",
        "insight": "Receives NGN 12M/month in receivables via bank transfer",
        "recommendation": "POS terminal for incoming customer payments",
        "confidence": 0.89,
        "productCategory": "pos_terminal",
        "evidenceNote": "Consistent high-volume incoming transfers indicate demand for in-person card capture.",
        "detectedAt": "2026-04-10T07:00:00.000Z"
      }
    ]
  }
}

Churn risk

GET/v1/businesses/{businessId}/intelligence/churn-risk

Attrition risk assessment blended from engagement and financial signals.

Response — 200

{
  "success": true,
  "data": {
    "businessId": "biz_001",
    "churnRisk": "low",
    "churnProbability": 0.05,
    "computedAt": "2026-04-17T10:30:00.000Z",
    "riskFactors": [
      { "factor": "Platform activity", "value": "Daily active", "impact": "low_risk" },
      { "factor": "Feature adoption", "value": "88%", "impact": "low_risk" },
      { "factor": "Revenue trend", "value": "+7.1%", "impact": "low_risk" }
    ]
  }
}

Risk levels: low (< 15%), moderate (15–40%), high (40–70%), critical (> 70%).

Cash-flow forecast

GET/v1/businesses/{businessId}/intelligence/cash-flow-forecast

Projected cash position at 30/60/90-day horizons, with confidence bands.

Query parameters

FieldTypeRequiredNotes
horizonDaysintegerno30, 60, or 90. Default 90.

The forecast blends outstanding receivables at the historical DSO, scheduled loan repayments, and recurring expenses. Each bucket includes a confidencePercent that decays as the horizon extends.

403 response for retail keys

{
  "success": false,
  "error": {
    "code": "ENTERPRISE_ONLY",
    "message": "This endpoint requires an enterprise subscription. Contact sales at https://finorabusiness.com/contact",
    "requestId": "req_..."
  }
}

Interested in the scoring engine?

The Business Score and its derivatives power credit decisioning, relationship management, and executive dashboards for our bank partners. Contact sales to discuss how it fits your programme.

Related endpoints

Reference index

Back to all modules