plaid

Retrieve a Consumer Report as a Verification PDF

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 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

Changes

Changed in 8 of the 53 revisions of this API.7188

Jul 22, 2026a1bbca018160131See the full diff
- ●
  added the new ASSETS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENRICH_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new PROFILE_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ○
  added the new optional request property hide_gse_details
  new-optional-request-property
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b413See the full diff
- ▲
  added CraCheckReportVerificationPdfReportType subschema #2 to the report_requested request property allOf list
  request-property-all-of-added
- ▲
  removed the enum value employment_refresh of the request property report_requested
  request-property-enum-value-removed
- ▲
  removed the enum value voa of the request property report_requested
  request-property-enum-value-removed
- ▲
  the report_requested request property type/format changed from string/ to /
  request-property-type-changed
- ●
  added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ○
  added the new optional request property reports_requested
  new-optional-request-property
- ○
  the request property report_requested became optional
  request-property-became-optional
- ○
  request property report_requested deprecated
  request-property-deprecated
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 26, 20268addecd0b74a11See the full diff
- ▲
  added the new required request property report_requested
  new-required-request-property
- ●
  removed the request property report_type
  request-property-removed
Dec 11, 2025465584b48c99112See the full diff
- ▲
  the user_id request property type/format changed from / to string/
  request-property-type-changed
- ●
  removed NewUserID from the user_id request property allOf list
  request-property-all-of-removed
- ○
  added the optional property provided_account_subtypes to the response with the default status
  response-optional-property-added
- ○
  added the optional property required_account_subtypes to the response with the default status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 20254abee1c5692911See the full diff
- ●
  removed subschema #2 from the user_id request property allOf list
  request-property-all-of-removed
- ○
  removed the IDENTITY_ERROR enum value from the error_type response property for the response status default
  response-property-enum-value-removed
Oct 22, 2025af4b6e71d87f1See the full diff
- ○
  endpoint added
  endpoint-added
Feb 21, 20245de70cc1e6ca1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history