plaid

(Deprecated) Get Account Insights for a Beacon User

Changed on

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

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beacon/user/account_insights/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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

OK

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

  • e07a869352e8Revision changes
    • info

      removed the charge card enum value from the /// response property for the response status

    • info

      removed the installment enum value from the /// response property for the response status

  • e536704a333fRevision changes
    • warning

      added the new charge card enum value to the /// response property for the response status

    • warning

      added the new commercial line of credit enum value to the /// response property for the response status

    • warning

      added the new home equity loan enum value to the /// response property for the response status

    • warning

      added the new installment enum value to the /// response property for the response status

    • warning

      added the new prediction market enum value to the /// response property for the response status