Get Account Insights for a Beacon User

POST /beacon/user/account_insights/get

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.

Request Body

Required

Request input for fetching the risk insights for a Beacon User’s Bank Accounts

Parameters

beacon_user_id
required, string
ID of the associated Beacon User.
access_token
required, string
The access token associated with the Item data is being requested for.
client_id
string
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.
secret
string
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.

Response

The response schema for /beacon/user/account/insights/get

Response Properties

beacon_user_id
required, string
ID of the associated Beacon User.
created_at
required, string
An ISO8601 formatted timestamp.
updated_at
required, string
An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.
bank_account_insights
required, object
A collection of Bank Accounts linked to an Item that is associated with this Beacon User.
item_id
required, string
The Plaid Item ID the Bank Accounts belong to.
accounts
required, array[object]
account_id
required, string
The Plaid account_id
type
required, string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository account loan: Loan account other: Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.
subtype
required, string
See the Account type schema for a full listing of account types and corresponding subtypes.
attributes
required, object
The attributes object contains data that can be used to assess account risk. Examples of data include: days_since_first_plaid_connection: The number of days since the first time the Item was connected to an application via Plaid plaid_connections_count_7d: The number of times the Item has been connected to applications via Plaid over the past 7 days plaid_connections_count_30d: The number of times the Item has been connected to applications via Plaid over the past 30 days total_plaid_connections_count: The number of times the Item has been connected to applications via Plaid For the full list and detailed documentation of core attributes available, or to request that core attributes not be returned, contact Sales or your Plaid account manager
days_since_first_plaid_connection
required, integer
The number of days since the first time the Item was connected to an application via Plaid
is_account_closed
required, boolean
Indicates if the account has been closed by the financial institution or the consumer, or is at risk of being closed
is_account_frozen_or_restricted
required, boolean
Indicates whether the account has withdrawals and transfers disabled or if access to the account is restricted. This could be due to a freeze by the credit issuer, legal restrictions (e.g., sanctions), or regulatory requirements limiting monthly withdrawals, among other reasons
total_plaid_connections_count
required, integer
The total number of times the item has been connected to applications via Plaid
plaid_connections_count_7d
required, integer
The number of times the Item has been connected to applications via Plaid over the past 7 days
plaid_connections_count_30d
required, integer
The number of times the Item has been connected to applications via Plaid over the past 30 days
failed_plaid_non_oauth_authentication_attempts_count_3d
required, integer
The number of failed non-OAuth authentication attempts via Plaid for this bank account over the past 3 days
plaid_non_oauth_authentication_attempts_count_3d
required, integer
The number of non-OAuth authentication attempts via Plaid for this bank account over the past 3 days
failed_plaid_non_oauth_authentication_attempts_count_7d
required, integer
The number of failed non-OAuth authentication attempts via Plaid for this bank account over the past 7 days
plaid_non_oauth_authentication_attempts_count_7d
required, integer
The number of non-OAuth authentication attempts via Plaid for this bank account over the past 7 days
failed_plaid_non_oauth_authentication_attempts_count_30d
required, integer
The number of failed non-OAuth authentication attempts via Plaid for this bank account over the past 30 days
plaid_non_oauth_authentication_attempts_count_30d
required, integer
The number of non-OAuth authentication attempts via Plaid for this bank account over the past 30 days
distinct_ip_addresses_count_3d
required, integer
The number of distinct IP addresses linked to the same bank account during Plaid authentication in the last 3 days
distinct_ip_addresses_count_7d
required, integer
The number of distinct IP addresses linked to the same bank account during Plaid authentication in the last 7 days
distinct_ip_addresses_count_30d
required, integer
The number of distinct IP addresses linked to the same bank account during Plaid authentication in the last 30 days
distinct_ip_addresses_count_90d
required, integer
The number of distinct IP addresses linked to the same bank account during Plaid authentication in the last 90 days
distinct_user_agents_count_3d
required, integer
The number of distinct user agents linked to the same bank account during Plaid authentication in the last 3 days
distinct_user_agents_count_7d
required, integer
The number of distinct user agents linked to the same bank account during Plaid authentication in the last 7 days
distinct_user_agents_count_30d
required, integer
The number of distinct user agents linked to the same bank account during Plaid authentication in the last 30 days
distinct_user_agents_count_90d
required, integer
The number of distinct user agents linked to the same bank account during Plaid authentication in the last 90 days
address_change_count_28d
required, integer
The number of times the account’s addresses on file have changed over the past 28 days
email_change_count_28d
required, integer
The number of times the account’s email addresses on file have changed over the past 28 days
phone_change_count_28d
required, integer
The number of times the account’s phone numbers on file have changed over the past 28 days
address_change_count_90d
required, integer
The number of times the account’s addresses on file have changed over the past 90 days
email_change_count_90d
required, integer
The number of times the account’s email addresses on file have changed over the past 90 days
phone_change_count_90d
required, integer
The number of times the account’s phone numbers on file have changed over the past 90 days
days_since_account_opening
required, integer
The number of days since the bank account was opened, as reported by the financial institution
days_since_first_observed_transaction
required, integer
The number of days since the oldest transaction available to Plaid for this account. This measure, combined with Plaid connection history, can be used to infer the age of the account
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.