Retrieve the pdf reports associated with a relay token that was shared with you (beta)

POST /credit/relay/pdf/get

/credit/relay/pdf/get allows third parties to receive a pdf report that was shared with them, using a relay_token that was created by the report owner.

The /credit/relay/pdf/get endpoint retrieves the Asset Report in PDF format. Before calling /credit/relay/pdf/get, you must first create the Asset Report using /credit/relay/create and then wait for the PRODUCT_READY webhook to fire, indicating that the Report is ready to be retrieved.

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

View a sample PDF Asset Report.

Request Body

Required

CreditRelayPDFGetRequest defines the request schema for /credit/relay/pdf/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.
relay_token
required, string
The relay_token granting access to the report you would like to get.
report_type
required, string
The report type. It can be asset. Income report types are not yet supported.