Refresh an Asset Report

POST /asset_report/refresh

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.

The 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 your original /asset_report/create request, but the original days_requested value and the values of any parameters in the options object can be overridden with new values. To change these arguments, simply supply new values for them in your request to /asset_report/refresh. Submit an empty string ("") for any previously-populated fields you would like set as empty.

Request Body

Required

AssetReportRefreshRequest defines the request schema for /asset_report/refresh

Parameters

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.
asset_report_token
required, string
The asset_report_token returned by the original call to /asset_report/create
days_requested
integer
The maximum number of days of history to include in the Asset Report. Must be an integer. If not specified, the value from the original call to /asset_report/create will be used.
options
object
An optional object to filter /asset_report/refresh results. If provided, cannot be null. If not specified, the options from the original call to /asset_report/create will be used.
client_report_id
string
Client-generated identifier, which can be used by lenders to track loan applications.
webhook
string
URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.
user
object
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.
client_user_id
string
An identifier you determine and submit for the user. If using the Credit Dashboard, Customers should pass in the user_token created in /user/create.
first_name
string
The user’s first name. Required for the Fannie Mae Day 1 Certainty™ program.
middle_name
string
The user’s middle name
last_name
string
The user’s last name. Required for the Fannie Mae Day 1 Certainty™ program.
ssn
string
The user’s Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program. Format: “ddd-dd-dddd”
phone_number
string
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.
email
string
The user’s email address.

Response

AssetReportRefreshResponse defines the response schema for /asset_report/refresh

Response Properties

asset_report_id
required, string
A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
asset_report_token
required, string
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.
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.