plaid

(Deprecated) Get Account Insights for a Beacon User

Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.

post/beacon/user/account_insights/get

Request body

beacon_user_idstring required

ID of the associated Beacon User.

access_tokenstring required

The access token associated with the Item for which data is being requested.

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Example request

{
  "beacon_user_id": "becusr_42cF1MNo42r9Xj"
}

Response

beacon_user_idstring required

ID of the associated Beacon User.

created_atstring date-time required

An ISO8601 formatted timestamp.

updated_atstring date-time required

An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "beacon_user_id": "becusr_42cF1MNo42r9Xj",
  "created_at": "2020-07-24T03:26:02Z",
  "updated_at": "2020-07-24T03:26:02Z",
  "bank_account_insights": {
    "item_id": "515cd85321d3649aecddc015",
    "accounts": [
      {
        "account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
        "attributes": {
          "days_since_first_plaid_connection": 1,
          "total_plaid_connections_count": 1,
          "plaid_connections_count_7d": 1,
          "plaid_connections_count_30d": 1,
          "failed_plaid_non_oauth_authentication_attempts_count_3d": 1,
          "plaid_non_oauth_authentication_attempts_count_3d": 1,
          "failed_plaid_non_oauth_authentication_attempts_count_7d": 1,
          "plaid_non_oauth_authentication_attempts_count_7d": 1,
          "failed_plaid_non_oauth_authentication_attempts_count_30d": 1,
          "plaid_non_oauth_authentication_attempts_count_30d": 1,
          "distinct_ip_addresses_count_3d": 1,
          "distinct_ip_addresses_count_7d": 1,
          "distinct_ip_addresses_count_30d": 1,
          "distinct_ip_addresses_count_90d": 1,
          "distinct_user_agents_count_3d": 1,
          "distinct_user_agents_count_7d": 1,
          "distinct_user_agents_count_30d": 1,
          "distinct_user_agents_count_90d": 1,
          "address_change_count_28d": 1,
          "email_change_count_28d": 2,
          "phone_change_count_28d": 1,
          "address_change_count_90d": 3,
          "email_change_count_90d": 4,
          "phone_change_count_90d": 2,
          "days_since_account_opening": 365,
          "days_since_first_observed_transaction": 180
        }
      }
    ]
  }
}

Changes

Changed in 7 of the 53 revisions of this API.1136

Aug 17, 2026e536704a333f5See the full diff
- ●
  added the new charge card enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new commercial line of credit enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new home equity loan enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new installment enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new prediction market enum value to the /// response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 202694406d9a4d271See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
Apr 17, 2026b9a2871636de1See the full diff
- ●
  added the new limited purpose checking enum value to the /// response property for the response status
  response-property-enum-value-added
Apr 2, 20267f9a02ad0ce37See the full diff
- ●
  added the new fhsa enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new qshr enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new roth 403B enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new roth 457b enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new roth pension enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new roth profit sharing plan enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new roth thrift savings plan enum value to the /// response property for the response status
  response-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 4, 2024a2c34406c3174See the full diff
- ○
  removed the recurring enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the rewards enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the safe deposit enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the undefined enum value from the /// response property for the response status
  response-property-enum-value-removed
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 5, 20241e30969bd8891See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 21, 20245de70cc1e6ca1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history