Freedom Debt Relief API integration & client data export

Authorized client login

Mirror the mobile app's authorization flow with a server-to-server OAuth wrapper. Tokens are bound to the consenting client, refreshed automatically, and revocable from a single admin endpoint. Useful when a financial wellness app needs to display a member's debt-relief progress without storing the FDR password.

Settlement offer streaming

The mobile app sends a push notification the moment a settlement offer is available. Our integration converts that signal into a webhook payload containing the creditor, balance, settlement percentage and authorization deadline, so an advisor or CRM can react before the offer expires.

Dedicated account balance API

Returns the current dedicated escrow balance, the date and amount of the most recent deposit, and the next scheduled deposit. Ideal input for budgeting widgets, payroll-aligned cash-flow planners and overdraft warnings.

Enrolled debt list

Surfaces every enrolled account with creditor name, original balance, current negotiated balance, status flag and projected settlement window. Powers portfolio dashboards, risk scoring and educational coaching tools.

Savings tracker endpoint

The "See Your Savings" view compares actual savings against a baseline of minimum payments. We expose that calculation as JSON so comparison engines and ROI calculators can render an apples-to-apples figure on the consumer's preferred dashboard.

Statement export

Generates monthly or YTD statements as CSV, JSON or PDF, including each settled account, the settlement amount, the FDR fee, and any forgiven-debt totals relevant for 1099-C tax reporting.

1. Financial wellness aggregation

A consumer fintech wants to show debt-relief progress alongside budgeting and credit data. The integration calls our enrolled-debt and savings endpoints under the user's authorized OAuth token, then renders a tile inside the wellness dashboard. Maps cleanly to the OpenFinance pattern of consent-driven third-party data access.

2. Credit counseling CRM sync

Non-profit credit counseling agencies that refer clients into a settlement program want a single case file. We deliver webhooks into Salesforce or HubSpot on each settlement authorization, including creditor, settled amount and savings; the agency advisor sees the update without logging into FDR's portal.

3. Bookkeeper and tax-prep export

Settled debt over $600 may trigger a 1099-C cancellation-of-debt notice. The statement export endpoint produces a YTD CSV listing each settled account, settlement amount, FDR fee and forgiven balance, ready to drop into QuickBooks Online or a tax preparer's working file.

4. Compliance & audit archive

Regulated debt servicers must retain proof of consent and authorization. We subscribe to settlement-authorization webhooks, sign each event with HMAC, and archive them in S3 (or any S3-compatible object store) with retention policies aligned to the FTC Telemarketing Sales Rule record-keeping window.

5. Personal dashboard in Notion or Sheets

Individual users sometimes just want to combine their FDR balance with bank balances inside a Google Sheets or Notion dashboard. We provide a thin REST proxy with API-key auth and a sample Apps Script function that pulls the current dedicated account balance once an hour.

Authorize a client session

POST /api/v1/fdr/auth/login
Content-Type: application/json

{
  "client_id": "fdr_client_8a91...",
  "auth_payload": "<authorized session bundle>",
  "scope": ["settlements.read", "deposits.read", "debts.read"]
}

200 OK
{
  "access_token": "eyJhbGciOi...",
  "expires_in": 3600,
  "refresh_token": "rt_3c8...",
  "consent_id": "cnst_2026_05_03_8a91"
}

Pull settlement progress for a date range

GET /api/v1/fdr/settlements?from=2026-01-01&to=2026-04-30
Authorization: Bearer eyJhbGciOi...

200 OK
{
  "client_id": "fdr_client_8a91...",
  "settlements": [
    {
      "creditor": "Capital One",
      "original_balance": 4820.55,
      "settled_balance": 1928.22,
      "savings_pct": 60.0,
      "status": "paid",
      "authorized_at": "2026-03-14T18:22:11Z"
    }
  ],
  "page": {"next": null}
}

Settlement-offer webhook payload

POST https://your-app.example.com/hooks/fdr
X-FDR-Signature: t=1746301200,v1=4f1c9...

{
  "event": "settlement.offer.created",
  "occurred_at": "2026-05-03T15:00:00Z",
  "client_id": "fdr_client_8a91...",
  "creditor": "Discover",
  "original_balance": 7320.10,
  "offered_settlement": 2562.04,
  "savings_pct": 65.0,
  "expires_at": "2026-05-10T23:59:00Z"
}

Regulatory framing

Freedom Debt Relief operates as a debt settlement provider in the United States. The integration is designed to sit inside the boundaries set by the Gramm-Leach-Bliley Act (Regulation P), the FTC Telemarketing Sales Rule's debt-relief provisions, and CFPB guidance on consumer financial data access. Where state privacy laws (CCPA/CPRA, Virginia CDPA, Colorado CPA, etc.) impose stricter requirements on downstream processors, the deliverable includes the matching consent and deletion endpoints.

Operating principles

• No unauthorized scraping; access is gated on a stored consent record.
• Data minimization at the response layer — only fields the integration explicitly asked for.
• Encrypted at rest, transport via TLS 1.2+, signed webhooks with rotating secrets.
• Audit log for every authorization event; retention aligned with the FTC record-keeping window.
• NDA available before sandbox access is shared.

Who we are

OpenFinance Lab is an independent studio focused on protocol analysis and OpenData / OpenFinance API integration for mobile financial apps. Our engineers come from banks, payment gateways and consumer fintech, and we ship end-to-end integrations under privacy and consent constraints.

• Debt relief, lending, payments, insurtech and personal financial management
• Custom Python, Node.js and Go SDKs with test harnesses
• Compliance-aware delivery: GLBA, CCPA/CPRA, CFPB guidance, FTC TSR
• Source code delivery from $300 — runnable API source plus full documentation; pay after delivery upon satisfaction.
• Pay-per-call API billing — access our hosted endpoint, pay only per call, no upfront cost; ideal for usage-based teams.

Deliverables checklist

• OpenAPI / Swagger specification for every exposed endpoint
• Protocol and authorization flow report (token chain, refresh cadence)
• Runnable source for login, statement export and webhook receiver
• Automated test suite plus Postman collection
• Compliance guidance: consent template, retention policy, deletion endpoint
• Operations runbook for token rotation and incident response