{ "opencollection": "1.0.0", "info": { "name": "Plaid asset report/", "version": "2020-09-14_1.517.0" }, "items": [ { "info": { "name": "Plaid", "type": "folder" }, "items": [ { "info": { "name": "Plaid Create an Asset Report", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/create", "body": { "type": "json", "data": "{}" } }, "docs": "The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints.\n\nThe Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds " }, { "info": { "name": "Plaid Retrieve an Asset Report", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/get", "body": { "type": "json", "data": "{}" } }, "docs": "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 opp" }, { "info": { "name": "Plaid Retrieve a PDF Asset Report", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/pdf/get", "body": { "type": "json", "data": "{}" } }, "docs": "The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/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\nThe response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is r" }, { "info": { "name": "Plaid Refresh an Asset Report", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/refresh", "body": { "type": "json", "data": "{}" } }, "docs": "An Asset Report is an immutable snapshot of a user's assets. In order to \"refresh\" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available.\n\nThe new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with y" }, { "info": { "name": "Plaid Filter Asset Report", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/filter", "body": { "type": "json", "data": "{}" } }, "docs": "By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/as" }, { "info": { "name": "Plaid Delete an Asset Report", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/remove", "body": { "type": "json", "data": "{}" } }, "docs": "The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically.\n\nThe `/asset_report/remove` endpoint allows you to remove access to an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access R" }, { "info": { "name": "Plaid Create Asset Report Audit Copy", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/audit_copy/create", "body": { "type": "json", "data": "{}" } }, "docs": "Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report.\n\nTo grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each thir" }, { "info": { "name": "Plaid Retrieve an Asset Report Audit Copy", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/audit_copy/get", "body": { "type": "json", "data": "{}" } }, "docs": "`/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`." }, { "info": { "name": "Plaid Remove Asset Report Audit Copy", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/asset_report/audit_copy/remove", "body": { "type": "json", "data": "{}" } }, "docs": "The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy." }, { "info": { "name": "Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/credit/asset_report/freddie_mac/get", "body": { "type": "json", "data": "{}" } }, "docs": "The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format." } ] } ], "bundled": true }