Calculate covenant headroom API

Compute headroom for caller-supplied financial covenants against metric values and thresholds. Returns the exact threshold, headroom formula, and breach status. No credit bureau is contacted.

The Calculate covenant headroom operation is part of the Financial Schedule & Credit Calculations API on BRAINIAC.software. Compute headroom for caller-supplied financial covenants against metric values and thresholds. Returns the exact threshold, headroom formula, and breach status. No credit bureau is contacted. It is exposed as POST /api/v1/fintech/covenant-headroom-calculate and priced at $0.04 USDC on Base. Payment uses the x402 exact scheme: an unpaid call returns HTTP 402 with payment requirements; after paying the exact USDC amount, retry the same request with a payment-signature header and Idempotency-Key. No account and no API key are required. Data sources for this product: Caller-supplied payment schedules, facilities, metrics, covenants, receivables, and dilution events processed locally Limitations: Schedule stress delays inflows while contractual outflows stay on their dates. It is not a credit-agency default probability. Waterfall and dilution math stay inside one currency. No FX conversion is applied. Covenant headroom uses only supplied metric values and thresholds. No bank account, bureau, or market feed is contacted. Outputs are compliance prechecks, drafts, or data lookups for human review. They are not official determinations, legal advice, identity confirmation, or certified filings. Related operations in this group include Audit financial schedule stress, Simulate repayment waterfall, Analyze receivables dilution. Open the group documentation for the full request schema, field notes, and response examples before integrating.

POST$0.04 USDC
/api/v1/fintech/covenant-headroom-calculate

Example request

curl -i -X POST "https://www.brainiac.software/api/v1/fintech/covenant-headroom-calculate" \
  -H 'content-type: application/json' \
  -H 'Idempotency-Key: <fresh-64-character-random-hex-key>' \
  --data-binary @- <<'JSON'
{
  "currency": "USD",
  "metrics": [
    {
      "id": "leverage",
      "name": "Net leverage",
      "value": 320
    },
    {
      "id": "interest_cover",
      "name": "Interest cover",
      "value": 250
    }
  ],
  "covenants": [
    {
      "id": "c1",
      "name": "Max leverage",
      "metric_id": "leverage",
      "operator": "lte",
      "threshold": 350
    },
    {
      "id": "c2",
      "name": "Min interest cover",
      "metric_id": "interest_cover",
      "operator": "gte",
      "threshold": 200
    }
  ]
}
JSON

An unpaid probe returns HTTP 402 with x402 payment requirements. After paying the exact USDC amount on Base, retry the identical request with a payment-signature header.

FAQ

  • Do I need an API key? No. Pay the listed USDC amount with x402.
  • What network? Base (eip155:8453), USDC.
  • Is this an official determination? No. Results are for human review against the cited sources.

Related APIs

Financial Schedule & Credit Calculations APIFull docsHow it works