POST /asset_report/audit_copy/pdf/get

The /asset_report/audit_copy/pdf/get endpoint retrieves an Asset Report Audit Copy in PDF format. The caller must provide the audit_copy_token that was shared via the /asset_report/audit_copy/create endpoint.

The response to /asset_report/audit_copy/pdf/get is the PDF binary data. The request_id is returned in the Plaid-Request-ID header.

View a sample PDF Asset Report.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
client_id String No

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.

options Object No

An optional object to filter or add data to /asset_report/get results. If provided, must be non-null.

options.days_to_include Integer No

The maximum integer number of days of history to include in the Asset Report.

audit_copy_token String Yes

The audit_copy_token granting access to the Audit Copy you would like to get as a PDF.

secret String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.