plaid

Retrieve an Asset Report

Changed on

The /asset_report/get endpoint retrieves the Asset Report in JSON format. Before calling /asset_report/get, you must first create the Asset Report using /asset_report/create (or filter an Asset Report using /asset_report/filter) and then wait for the PRODUCT_READY webhook to fire, indicating that the Report is ready to be retrieved.

By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the /asset_report/get endpoint with include_insights set to true.

For latency-sensitive applications, you can optionally call /asset_report/create with options.add_ons set to ["fast_assets"]. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.

post/asset_report/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/asset_report/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

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.

asset_report_tokenstring

A token that can be provided to endpoints such as /asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.

user_tokenstring

The user token associated with the User for which to create an asset report for. The latest asset report associated with the User will be returned

include_insightsboolean

true if you would like to retrieve the Asset Report with Insights, false otherwise. This field defaults to false if omitted.

fast_reportboolean

true to fetch "fast" version of asset report. Defaults to false if omitted. Can only be used if /asset_report/create was called with options.add_ons set to ["fast_assets"].

Response

OK

request_idstring required

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

Changes

  • ea443cd78f6fRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

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

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

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

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added to the / response property allOf list for the response status

  • e07a869352e8Revision changes
    • breaking

      the response property ////////// became nullable for the status

    • info

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

    • info

      removed the fund fee enum value from the //////// response property for the response status

    • info

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

    • info

      removed the loan payment enum value from the //////// response property for the response status

    • info

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