Create Asset Report Audit Copy

POST /asset_report/audit_copy/create

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.

To 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 third party has its own auditor_id, for example fannie_mae. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.

Request Body

Required

AssetReportAuditCopyCreateRequest defines the request schema for /asset_report/audit_copy/get

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
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.
auditor_id
string
The auditor_id of the third party with whom you would like to share the Asset Report.

Response

AssetReportAuditCopyCreateResponse defines the response schema for /asset_report/audit_copy/get

Response Properties

audit_copy_token
required, string
A token that can be shared with a third party auditor to allow them to obtain access to the Asset Report. This token should be stored securely.
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.