plaid

Retrieve a Base Report

This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you've received a CHECK_REPORT_READY or a USER_CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create.

post/cra/check_report/base_report/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.

item_idsItemId[] nullable

The Item IDs to include in the Base Report. If not provided, all Items associated with the user will be included.

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.

user_tier'free' | 'paid' | 'null' nullable

The tier of the user.

report_idstring

The CRA report token (formatted cra-report-<env>-<uuid>) identifying a specific consumer report. When provided alongside consumer_report_permissible_purpose, pins retrieval to that report and stamps its permissible purpose. If omitted, the most recently generated report for the user is returned.

consumer_report_permissible_purpose'ACCOUNT_REVIEW_CREDIT' | 'WRITTEN_INSTRUCTION_OTHER'

The permissible purpose under the FCRA for retrieving this consumer report. Restricted to permissible purposes related to loan servicing only. Required when report_id is provided.

Response

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

Changed in 27 of the 52 revisions of this API.96280

Aug 17, 2026e536704a333f52See the full diff
- ●
  added the new charge card enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new commercial line of credit enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new home equity loan enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new installment enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new prediction market enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ○
  the security scope cra:read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope cra:report:read was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2026a1bbca018160264See 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 ASSETS_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 CRA_MONITORING_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 CREDIT_PROFILE_REPORT_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 ENCOMPASS_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 ENRICH_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 FRAUD_INSIGHTS_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 FREDDIE_MAC_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 LINK_DELIVERY_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 PROFILE_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 RECURRING_TRANSACTIONS_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 STATEMENTS_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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_RECURRING_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  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 TRANSFER_REFUND_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  response-property-enum-value-added
- ○
  the endpoint scheme security clientId AND secret AND plaidVersion was added to the API
  api-security-added
- ○
  the endpoint scheme security oauth2 was added to the API
  api-security-added
- ○
  added the new optional request property consumer_report_permissible_purpose
  new-optional-request-property
- ○
  added the new optional request property report_id
  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, 202680d23bfdc2e52See 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
- ●
  added the new IDEMPOTENCY_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b2See the full diff
- ●
  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 BASE_REPORT_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  response-property-enum-value-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 17, 2026b9a2871636de1See the full diff
- ●
  added the new limited purpose checking enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
Apr 2, 20267f9a02ad0ce371See the full diff
- ●
  added the new fhsa enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new qshr enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth 403B enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth 457b enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth pension enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth profit sharing plan enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ●
  added the new roth thrift savings plan enum value to the report/items/items/accounts/items/subtype response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property user_tier
  new-optional-request-property
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 2026ac31f04fdb581See the full diff
- ○
  added the optional property report/items/items/accounts/items/transactions/items/personal_finance_category to the response with the 200 status
  response-optional-property-added
Dec 11, 2025465584b48c99114See 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
- ○
  added the optional property warnings/items/cause/allOf[subschema #1: Error]/provided_account_subtypes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property warnings/items/cause/allOf[subschema #1: Error]/required_account_subtypes to the response with the 200 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, 20254abee1c5692912See 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
- ○
  removed the IDENTITY_ERROR enum value from the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  response-property-enum-value-removed
Nov 12, 2025f8b9f1a857672See the full diff
- ●
  added the new IDENTITY_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new USER_ERROR enum value to the warnings/items/cause/allOf[subschema #1: Error]/error_type response property for the response status 200
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (27 revisions)