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
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
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
access_tokens
assets product must have been initialized for the Items during link; the Assets product cannot be added after initialization.
days_requested
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
/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
webhook
include_fast_report
products
"investments"
add_ons
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
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
user_token created in /user/create.
first_name
middle_name
last_name
ssn
phone_number
email
require_all_items
Response
AssetReportCreateResponse defines the response schema for /asset_report/create
Response Properties
asset_report_token
/asset_report/get or /asset_report/pdf/get to fetch or update an Asset Report.
asset_report_id
request_id