action plaid_asset_report_get { label: "Retrieve an Asset Report" description: "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`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved.\n\nBy 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.\n\nTo retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`." provider: plaid method: POST path: "/asset_report/get" encoding: json input: { type: "object" description: "AssetReportGetRequest defines the request schema for `/asset_report/get`" required: ["asset_report_token"] properties: { asset_report_token: { type: "string" description: "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." } client_id: { type: "string" description: "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." } fast_report: { type: "boolean" description: "`true` to fetch \"fast\" version of asset report. Defaults to false if omitted." } include_insights: { type: "boolean" description: "`true` if you would like to retrieve the Asset Report with Insights, `false` otherwise. This field defaults to `false` if omitted." } options: { type: "object" description: "An optional object to filter or add data to `/asset_report/get` results. If provided, must be non-`null`." properties: { days_to_include: { type: "integer" description: "The maximum integer number of days of history to include in the Asset Report." } } } secret: { type: "string" description: "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." } } } output: { type: "object" description: "AssetReportGetResponse defines the response schema for `/asset_report/get`" required: ["report", "request_id", "warnings"] properties: { report: { type: "object" description: "An object representing an Asset Report" required: ["asset_report_id", "client_report_id", "date_generated", "days_requested", "items", "user"] properties: { asset_report_id: { type: "string" description: "A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive." } client_report_id: { type: "string" description: "An identifier you determine and submit for the Asset Report." } date_generated: { type: "string" format: "date-time" description: "The date and time when the Asset Report was created, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. \"2018-04-12T03:32:11Z\")." } days_requested: { type: "number" description: "The duration of transaction history you requested" } items: { type: "array" description: "Data returned by Plaid about each of the Items included in the Asset Report." items: { type: "object" description: "A representation of an Item within an Asset Report." required: ["item_id", "institution_name", "institution_id", "date_last_updated", "accounts"] properties: { accounts: { type: "array" description: "Data about each of the accounts open on the Item." items: { description: "Asset information about an account" required: ["days_available", "transactions", "owners", "historical_balances"] type: "object" } } date_last_updated: { type: "string" format: "date-time" description: "The date and time when this Item’s data was last retrieved from the financial institution, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format." } institution_id: { type: "string" description: "The id of the financial institution associated with the Item." } institution_name: { type: "string" description: "The full financial institution name associated with the Item." } item_id: { type: "string" description: "The `item_id` of the Item associated with this webhook, warning, or error" } } } } user: { type: "object" description: "The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program." properties: { client_user_id: { type: "string" description: "An identifier you determine and submit for the user." } email: { type: "string" description: "The user's email address." } first_name: { type: "string" description: "The user's first name. Required for the Fannie Mae Day 1 Certainty™ program." } last_name: { type: "string" description: "The user's last name. Required for the Fannie Mae Day 1 Certainty™ program." } middle_name: { type: "string" description: "The user's middle name" } phone_number: { type: "string" description: "The user's phone number, in E.164 format: +{countrycode}{number}. For example: \"+14151234567\". Phone numbers provided in other formats will be parsed on a best-effort basis." } ssn: { type: "string" description: "The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.\n\nFormat: \"ddd-dd-dddd\"" } } } } } request_id: { type: "string" description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive." } warnings: { type: "array" description: "If the Asset Report generation was successful but identity information cannot be returned, this array will contain information about the errors causing identity information to be missing" items: { type: "object" description: "It is possible for an Asset Report to be returned with missing account owner information. In such cases, the Asset Report will contain warning data in the response, indicating why obtaining the owner information failed." required: ["warning_type", "warning_code", "cause"] properties: { cause: { type: "object" description: "An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items." required: ["item_id", "error_type", "error_code", "error_message", "display_message"] } warning_code: { type: "string" description: "The warning code identifies a specific kind of warning. Currently, the only possible warning code is `OWNERS_UNAVAILABLE`, which indicates that account-owner information is not available." enum: ["OWNERS_UNAVAILABLE"] } warning_type: { type: "string" description: "The warning type, which will always be `ASSET_REPORT_WARNING`" } } } } } } }