plaid

Retrieve a Consumer Report as a PDF

Changed on

/cra/check_report/pdf/get retrieves the most recent Consumer Report in PDF format. The most recent Base Report for the user is always included. Use the add_ons field to also include the most recent Income Insights, Partner Insights or LendScore report in the PDF.

post/cra/check_report/pdf/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cra/check_report/pdf/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

user_idstring

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

third_party_user_tokenstring

The third-party user token associated with the requested User data.

add_onsCraPDFAddOns[]

Use this field to include the most recent Income Insights, Partner Insights, or LendScore report in the PDF.

user_tokenstring

The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the user_token field. All other customers should use the user_id instead. For more details, see New User APIs.

Response

OK

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e07a869352e8Revision changes
    • info

      added the new cra_lend_score enum value to the request property /