Create an Asset Report

POST /asset_report/create

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.

The 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 to about one minute. When the Asset Report is ready to be retrieved using /asset_report/get or /asset_report/pdf/get, Plaid will fire a PRODUCT_READY webhook. For full details of the webhook schema, see Asset Report webhooks.

The /asset_report/create endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the /asset_report/refresh endpoint.

Request Body

Required

AssetReportCreateRequest defines the request schema for /asset_report/create

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.
access_tokens
array[string]
An array of access tokens corresponding to the Items that will be included in the report. The assets product must have been initialized for the Items during link; the Assets product cannot be added after initialization.
days_requested
required, integer
The maximum integer number of days of history to include in the Asset Report. If using Fannie Mae Day 1 Certainty, days_requested must be at least 61 for new originations or at least 31 for refinancings. An Asset Report requested with “Additional History” (that is, with more than 61 days of transaction history) will incur an Additional History fee.
options
object
An optional object to filter /asset_report/create results. If provided, must be non-null. The optional user object is required for the report to be eligible for Fannie Mae’s Day 1 Certainty program.
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.
include_fast_report
boolean
true to return balance and identity earlier as a fast report. Defaults to false if omitted.
products
array[string]
Additional information that can be included in the asset report. Possible values: "investments"
add_ons
array[string]
A list of add-ons that should be included in the Asset Report. When Fast Assets is requested, Plaid will create two versions of the Asset Report: the Fast Asset Report, which will contain only Identity and Balance information, and the Full Asset Report, which will also contain Transactions information. A PRODUCT_READY webhook will be fired for each Asset Report when it is ready, and the report_type field will indicate whether the webhook is firing for the full or fast Asset Report. To retrieve the Fast Asset Report, call /asset_report/get with fast_report set to true. There is no additional charge for using Fast Assets. To create a Fast Asset Report, Plaid must successfully retrieve both Identity and Balance data; if Plaid encounters an error obtaining this data, the Fast Asset Report will not be created. However, as long as Plaid can obtain Transactions data, the Full Asset Report will still be available. When Investments is requested, investments must be specified in the optional_products array when initializing Link.
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.
require_all_items
boolean
If set to false, only 1 item must be healthy at the time of report creation. The default value is true, which would require all items to be healthy at the time of report creation.

Response

AssetReportCreateResponse defines the response schema for /asset_report/create

Response Properties

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