API Documentation

Every open class-action settlement currently accepting claims: name, deadline, fund, eligibility text, proof requirements, state restrictions, and filing URL. Updated as settlements open, close, or change.

Settlement object

Schema v2: every record carries every field; a value that does not exist is null, never a missing key.

Closed US settlements (claim deadline passed), same schema as settlements.json with status "closed". Free — the archive is not a Pro feature. Sidecar: /api/closed-settlements.meta.json.

Canadian settlements, same schema; amounts are in CAD — read the currency field. Sidecar: /api/settlements-ca.meta.json.

Bake metadata for settlements.json: generated_at (ISO 8601, UTC), row_count, schema_version, license, and aggregate_fund_total (the sum of fundNum over aggregate records).

Court-filings index: cases with filed documents (ISO dates, page counts, hashes), each joined to its settlement by settlement_id where the settlement is in the dataset.

Pre-filtered CSV cuts of the open dataset (all settlements, closing windows, largest funds, no-proof-needed, per state), regenerated with every bake. The index page lists each cut with its row count.

OpenAPI 3.0 spec for this surface, generated from the baked payload — field types and nullability are measured from the data, not hand-written.

Pre-computed story leads for journalists: the 10 largest funds, the 10 closing soonest, and every settlement requiring no proof of purchase.

RSS 2.0 feed of open settlements ordered by deadline.

Creates a Stripe checkout session for the $29/month Pro subscription. Returns a checkout URL to redirect the customer to.

Response

{
  "ok": true,
  "checkout_url": "https://checkout.stripe.com/..."
}

Returns your Pro API key after checkout completes. Call with the checkout session ID:

GET /v1/key-for-session?session_id=cs_test_abc123

Response

{
  "ok": true,
  "api_key": "cah_live_...",
  "created": "2026-10-17T00:00:00Z"
}

Stripe webhook receiver. Verifies the Stripe signature, issues API keys on checkout.session.completed, and revokes keys when a subscription ends. Not called directly by API consumers.

Worker health check. No auth required.

{
  "ok": true,
  "service": "cah-api-tiers"
}

Matches a purchase history against the open settlement inventory and returns ranked eligibility suggestions. The API suggests; it never files. The user is always the filer — every claim is filed under penalty of perjury and only the user can attest to their own eligibility. There is deliberately no filing endpoint.

Request

POST /v1/eligibility/check
Content-Type: application/json
Authorization: Bearer YOUR_PRO_API_KEY

{
  "purchases": [
    {
      "description": "Oscar Mayer bacon 16oz",
      "merchant": "Safeway",
      "date": "2016-03-10",
      "amount": 6.49
    },
    {
      "description": "VSL#3 probiotic 60ct",
      "merchant": "CVS",
      "date": "2018-07-22",
      "amount": 58.00
    }
  ],
  "state": "CA",
  "options": {
    "min_confidence": 0.35,
    "max_results": 25,
    "include_unverified": false
  }
}

Request fields

Response

{
  "ok": true,
  "matches": [
    {
      "settlement_id": "pork-price-fixing-antitrust",
      "settlement_name": "Pork Price-Fixing Antitrust",
      "confidence": 0.92,
      "confidence_label": "high",
      "match_reasons": [
        "You bought bacon at Safeway in March 2016.",
        "This settlement covers raw pork and bacon bought at grocery stores in 24 states (including CA) from June 2014 to June 2018."
      ],
      "deadline": "2026-10-29",
      "deadline_label": "Oct 29, 2026",
      "estimated_payout": "not published",
      "proof_required": "no proof",
      "claim_url": "https://www.overchargedforpork.com",
      "verified": true,
      "state_restriction": null
    }
  ],
  "meta": {
    "settlements_checked": 279,
    "purchases_evaluated": 2,
    "model": "magnitude-local",
    "degraded": false,
    "processing_ms": 1840
  }
}

Match fields

Confidence rubric

Expired settlements (deadline in the past) are never returned.

Degraded mode

If the matching engine is unreachable, the endpoint falls back to keyword matching: confidence is capped at 0.5, meta.model is "keyword-fallback", and meta.degraded is true. Treat degraded results as a rough screen, not a determination.