plaid

Retrieve a Consumer Report as a Verification PDF

Changed on

The /cra/check_report/verification/pdf/get endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you've created a VOA report through Link or the /cra/check_report/create endpoint, and have received a CHECK_REPORT_READY or a USER_CHECK_REPORT_READY webhook.

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

post/cra/check_report/verification/pdf/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cra/check_report/verification/pdf/get
  • Auth
    • API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
    • or OAuth 2
      Client credentials
      Token URL: https://api.plaid.com/oauth2/apiv2/token scopes: cra:read

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.

report_requested'voa' | 'employment_refresh' | 'income'

Deprecated. Use reports_requested instead.

reports_requestedCraCheckReportVerificationPdfReportType[]

Specifies which types of verification reports to include in the returned PDF. Supported combinations are: [voa], [employment_refresh], [income], or [voa, income]. Other combinations are not supported.

hide_gse_detailsboolean

If true, the GSE identifiers (the Report ID and gse_reference_id) are omitted from the returned Home Lending Report PDF. Defaults to false. These identifiers are always present in the /cra/check_report/verification/get JSON response regardless of this field.

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

      the endpoint scheme security clientId AND secret AND plaidVersion was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API