> ## Documentation Index
> Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Debt Dashboard & Credit Insights

> Build real-time debt dashboards with account updates, card brand art, credit scores, and financial health attributes.

Once a user's liabilities are connected, the next step is turning that raw data into a useful dashboard. This guide covers pulling real-time account data, enriching cards with brand art, monitoring balances over time, and surfacing credit health insights.

All examples use Sarah Chen's accounts from the [Getting Started](/guides/use-cases/pfm/getting-started) guide.

## Debt Dashboard & Real-Time Monitoring

### Requesting an Account Update

[Updates](/guides/updates/overview) pull real-time data — balance, credit limit, APR, due dates, payment history — directly from the financial institution. This is the core data feed for any debt dashboard.

Request an update for Sarah's Chase Sapphire Reserve card:

<Tabs>
  <Tab title="Request">
    ```bash theme={null}
    curl https://production.methodfi.com/accounts/acc_eKKmrXDpJBKgw/updates \
      -X POST \
      -H "Method-Version: 2025-12-01" \
      -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
    ```
  </Tab>

  <Tab title="Response">
    ```json theme={null}
    {
      "id": "upt_NYV5kfjskTTCJ",
      "status": "completed",
      "account_id": "acc_eKKmrXDpJBKgw",
      "source": "direct",
      "type": "credit_card",
      "credit_card": {
        "available_credit": 1920000,
        "balance": 80000,
        "closed_at": null,
        "credit_limit": 2000000,
        "interest_rate_percentage_max": 22.49,
        "interest_rate_percentage_min": 22.49,
        "interest_rate_type": "variable",
        "last_payment_amount": 15000,
        "last_payment_date": "2025-08-28",
        "next_payment_due_date": "2025-10-01",
        "next_payment_minimum_amount": 2500,
        "opened_at": "2022-03-15",
        "sub_type": "flexible_spending",
        "usage_pattern": "transactor"
      },
      "data_as_of": "2025-09-15T14:45:00.000Z",
      "error": null,
      "created_at": "2025-09-15T14:45:00.000Z",
      "updated_at": "2025-09-15T14:45:00.312Z"
    }
    ```
  </Tab>
</Tabs>

Sarah's Chase card has an \$800.00 balance on a \$20,000.00 limit (4% utilization), with a minimum payment of \$25.00 due on October 1st. Her last payment of \$150.00 was made on August 28th, and her `usage_pattern` is `transactor` — she pays in full each month.

### Subscribing to Continuous Updates

Rather than polling for updates, subscribe to receive them automatically. When the financial institution reports new data, Method delivers it via webhook.

<Tabs>
  <Tab title="Request">
    ```bash theme={null}
    curl https://production.methodfi.com/accounts/acc_eKKmrXDpJBKgw/subscriptions \
      -X POST \
      -H "Method-Version: 2025-12-01" \
      -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
      -H "Content-Type: application/json" \
      -d '{
        "enroll": "update"
      }'
    ```
  </Tab>

  <Tab title="Response">
    ```json theme={null}
    {
      "id": "sub_xM4VcfRWcJP8D",
      "name": "update",
      "status": "active",
      "payload": null,
      "latest_request_id": "upt_NYV5kfjskTTCJ",
      "created_at": "2025-09-15T15:10:00.000Z",
      "updated_at": "2025-09-15T15:10:00.000Z"
    }
    ```
  </Tab>
</Tabs>

With the subscription active, Method will fire `update.create` and `update.update` webhook events whenever new data is available. Your app can refresh the dashboard in real time without the user taking any action.

### Card Brand Art

For credit card accounts, [Card Brand](/guides/additional-products/card-brand) retrieves the card's product name, issuer, network, and card art image. This lets your wallet UI display the actual card visual instead of a generic placeholder.

<Tabs>
  <Tab title="Request">
    ```bash theme={null}
    curl https://production.methodfi.com/accounts/acc_eKKmrXDpJBKgw/card_brands \
      -X POST \
      -H "Method-Version: 2025-12-01" \
      -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
    ```
  </Tab>

  <Tab title="Response">
    ```json theme={null}
    {
      "id": "cbrd_Accm7P6t6mYQP",
      "account_id": "acc_eKKmrXDpJBKgw",
      "brands": [
        {
          "id": "pdt_15_brd_1",
          "card_product_id": "pdt_15",
          "description": "Chase Sapphire Reserve",
          "name": "Chase Sapphire Reserve",
          "issuer": "Chase",
          "network": "visa",
          "network_tier": "infinite",
          "type": "specific",
          "url": "https://static.methodfi.com/card_brands/1b7ccaba6535cb837f802d968add4700.png"
        }
      ],
      "status": "completed",
      "source": "method",
      "error": null,
      "created_at": "2025-09-15T15:15:00.000Z",
      "updated_at": "2025-09-15T15:15:00.000Z"
    }
    ```
  </Tab>
</Tabs>

The `url` field provides a direct link to the card's art image, which you can render in your wallet or dashboard UI.

### Entity-Level Attributes

[Attributes](/guides/additional-products/attributes) provide entity-level financial health metrics aggregated across all of a user's accounts. These power features like credit health dashboards, utilization alerts, and financial wellness scores.

<Tabs>
  <Tab title="Request">
    ```bash theme={null}
    curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8/attributes \
      -X POST \
      -H "Method-Version: 2025-12-01" \
      -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
      -H "Content-Type: application/json" \
      -d '{
        "attributes": [
          "credit_health_credit_card_usage",
          "credit_health_payment_history",
          "credit_health_total_accounts",
          "credit_health_credit_age",
          "credit_health_derogatory_marks",
          "credit_health_hard_inquiries",
          "credit_health_open_accounts"
        ]
      }'
    ```
  </Tab>

  <Tab title="Response">
    ```json theme={null}
    {
      "id": "attr_nrPjaahMX4yRA",
      "entity_id": "ent_au22b1fbFJbp8",
      "status": "completed",
      "attributes": {
        "credit_health_credit_card_usage": {
          "value": 22,
          "rating": "good"
        },
        "credit_health_payment_history": {
          "value": 100,
          "rating": "excellent"
        },
        "credit_health_total_accounts": {
          "value": 12,
          "rating": "fair"
        },
        "credit_health_credit_age": {
          "value": 48,
          "rating": "fair"
        },
        "credit_health_derogatory_marks": {
          "value": 0,
          "rating": "excellent"
        },
        "credit_health_hard_inquiries": {
          "value": 2,
          "rating": "good"
        },
        "credit_health_open_accounts": {
          "value": 6,
          "rating": "no_rating"
        }
      },
      "error": null,
      "created_at": "2025-09-15T15:20:00.000Z",
      "updated_at": "2025-09-15T15:20:00.000Z"
    }
    ```
  </Tab>
</Tabs>

Sarah's attributes show 22% credit card utilization (rated "good"), 100% on-time payment history ("excellent"), zero derogatory marks ("excellent"), and a credit age of 48 months ("fair"). These data points map directly to the factors that credit scoring models weigh most heavily.

***

## Credit Building & Score Insights

### Retrieving Credit Scores

[Credit Scores](/guides/additional-products/credit-scores) retrieve the user's credit score sourced from Equifax using the VantageScore 4.0 model. The response includes contributing factors that explain what's helping or hurting the score.

<Tabs>
  <Tab title="Request">
    ```bash theme={null}
    curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8/credit_scores \
      -X POST \
      -H "Method-Version: 2025-12-01" \
      -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
    ```

    <Note>
      Credit score requests are asynchronous. The initial response will have `status: "pending"` and `scores: null`. You'll receive a webhook when the score is ready.
    </Note>
  </Tab>

  <Tab title="Response (completed)">
    ```json theme={null}
    {
      "id": "crs_pn4ca33GXFaCE",
      "entity_id": "ent_au22b1fbFJbp8",
      "status": "completed",
      "scores": [
        {
          "score": 734,
          "source": "equifax",
          "model": "vantage_4",
          "factors": [
            "Length of time accounts have been established",
            "Too few accounts currently paid as agreed",
            "Lack of recent installment loan information",
            "Proportion of balances to credit limits is too high on bank revolving or other revolving accounts"
          ],
          "created_at": "2025-09-15T15:25:00.000Z"
        }
      ],
      "error": null,
      "created_at": "2025-09-15T15:25:00.000Z",
      "updated_at": "2025-09-15T15:25:30.000Z"
    }
    ```
  </Tab>
</Tabs>

Sarah's VantageScore 4.0 is 734 ("Good" tier). The factors array explains what's influencing her score — you can surface these directly in your app to help users understand what actions would improve their score.

### Credit Score Subscriptions

To monitor Sarah's credit score over time, enroll her in a credit score subscription. Method will automatically check for score changes and send webhook events when her score increases or decreases.

<Tabs>
  <Tab title="Request">
    ```bash theme={null}
    curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8/subscriptions \
      -X POST \
      -H "Method-Version: 2025-12-01" \
      -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
      -H "Content-Type: application/json" \
      -d '{
        "enroll": "credit_score"
      }'
    ```
  </Tab>

  <Tab title="Response">
    ```json theme={null}
    {
      "id": "sub_c3a7hVjHCJzF3",
      "name": "credit_score",
      "status": "active",
      "payload": null,
      "latest_request_id": null,
      "created_at": "2025-09-15T15:30:00.000Z",
      "updated_at": "2025-09-15T15:30:00.000Z"
    }
    ```
  </Tab>
</Tabs>

With the subscription active, your app can power features like monthly score reports, trend charts, and push notifications ("Your credit score went up 12 points this month!") that drive engagement and retention.

### Combining Scores and Attributes

The most effective credit building experiences combine credit scores with attributes. The score tells users *where they stand*, while attributes tell them *why* and *what to do about it*:

| Attribute         | Sarah's Value | Rating    | What to Surface                                      |
| ----------------- | ------------- | --------- | ---------------------------------------------------- |
| Credit card usage | 22%           | Good      | "Your utilization is healthy — keep it under 30%"    |
| Payment history   | 100%          | Excellent | "Perfect payment record — keep it up!"               |
| Credit age        | 48 months     | Fair      | "Your accounts are relatively new — time helps here" |
| Derogatory marks  | 0             | Excellent | "No negative marks on your report"                   |
| Hard inquiries    | 2             | Good      | "2 recent inquiries — avoid applying for new credit" |

<Card title="Attributes API Reference" icon="chart-bar" href="/reference/entities/attributes/create">
  Full documentation for all available attribute types and their ratings.
</Card>

## What's Next

<CardGroup cols={2}>
  <Card title="Transactions & Payments" icon="money-bill-transfer" href="/guides/use-cases/pfm/transactions-payments">
    Stream credit card transactions for spend management and initiate bill payments.
  </Card>

  <Card title="Update Subscriptions Guide" icon="rotate" href="/guides/updates/subscriptions">
    Deep dive into update subscription types, frequencies, and webhook payloads.
  </Card>
</CardGroup>
