Retrieve a PDF Asset Report

v1.0.0

The /asset_report/pdf/get endpoint retrieves the Asset Report in PDF format. Before calling /asset_report/pdf/get, you must first create the Asset Report using /asset_report/create (or filter an Asset Report using /asset_report/filter) and then wait for the webhook to fire, indicating that the Report is ready to be retrieved.

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

Input

{
  "type": "object",
  "description": "AssetReportPDFGetRequest defines the request schema for `/asset_report/pdf/get`",
  "required": [
    "asset_report_token"
  ],
  "properties": {
    "asset_report_token": {
      "type": "string",
      "description": "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."
    },
    "client_id": {
      "type": "string",
      "description": "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": {
      "type": "object",
      "description": "An optional object to filter or add data to `/asset_report/get` results. If provided, must be non-`null`.",
      "properties": {
        "days_to_include": {
          "type": "integer",
          "description": "The maximum integer number of days of history to include in the Asset Report."
        }
      }
    },
    "secret": {
      "type": "string",
      "description": "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."
    }
  }
}

Output

{
  "type": "object",
  "additionalProperties": true
}