Insights API

Core service for processing financial data, generating credit scores, and analyzing transaction patterns. Requires an active subscription and API key.

Statement Processing

Upload and ingest financial statements.

POST/api/v1/insights/upload

Upload Statement

Upload a PDF or CSV statement for async processing.

{
  "success": true,
  "message": "Statement queued",
  "transactionCount": 150
}

POST/api/v1/insights/ingest

Ingest Transactions

Directly ingest raw transaction data.

{
  "success": true,
  "count": 1
}

Metrics & Scoring

Calculate financial health metrics and credit scores.

POST/api/v1/insights/metrics

Compute Metrics

Calculate affordability, cash flow, and income metrics.

{
  "averageMonthlyIncome": 150000,
  "expenseRatio": 0.4
}

GET/api/v1/insights/score

Get Credit Score

Retrieve the calculated credit score for the user/tenant.

{
  "score": 720,
  "rating": "A",
  "factors": [
    "Consistent income"
  ]
}

Decision Engine

Automated credit decisioning.

POST/api/v1/insights/decision

Make Decision

Get an automated approval decision based on configured rules.

{
  "decision": "APPROVED",
  "maxAmount": 75000
}