Sample - Plaid API
POST/beacon/user/account_insights/getDeprecated

Get Beacon User account insights

Retrieves account insights for all bank accounts linked to a Beacon User. Provide beacon_user_id and the relevant access_token to obtain insights based on the information most recently retrieved from the financial institution. The response identifies the linked Item and includes its account insights.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 body fields

Request input for retrieving bank account insights linked to a Beacon User.

beacon_user_idstringrequired
ID of the associated Beacon User.
access_tokenstringrequired
The access token associated with the Item for which data is being requested.
client_idstringoptional
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.
secretstringoptional
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.

1 status code
200Returns the Beacon User identifier, creation and update timestamps, bank account insights grouped by Item, and a request identifier.
beacon_user_idstringrequired
ID of the associated Beacon User.
created_atstringrequired
An ISO8601 formatted timestamp.
updated_atstringrequired
An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.
bank_account_insightsobjectrequired
A collection of Bank Accounts linked to an Item that is associated with this Beacon User.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

Both beacon_user_id and access_token are required. beacon_user_id must identify the Beacon User, and access_token must identify the Item whose linked accounts should be evaluated.