plaid

Retrieve the reports associated with a relay token that was shared with you

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

post/credit/relay/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.

relay_tokenstring required

The relay_token granting access to the report you would like to get.

report_type'asset' required

The report type. It can be asset. Income report types are not yet supported.

include_insightsboolean

true if you would like to retrieve the Asset Report with Insights, false otherwise. This field defaults to false if omitted.

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 19 of the 52 revisions of this API.2810386

Aug 17, 2026e536704a333f51See 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
- ○
  added the optional property report/items/items/accounts/items/investments/holdings/items/tax_lots to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2026a1bbca01816031See 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 BANK_INCOME_INSIGHTS_INCOMPLETE enum value to the warnings/items/warning_code response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BANK_INCOME_INSIGHTS_INSUFFICIENT_DATA enum value to the warnings/items/warning_code response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BANK_INCOME_INSIGHTS_INTERNAL_ERROR enum value to the warnings/items/warning_code response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BANK_INCOME_INSIGHTS_MISMATCHED_DAYS_REQUESTED enum value to the warnings/items/warning_code response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BANK_INCOME_INSIGHTS_STATUS_IN_PROGRESS enum value to the warnings/items/warning_code 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
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, 20267f9a02ad0ce37See 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
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2025465584b48c994See the full diff
- ○
  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, 20254abee1c569292See the full diff
- ○
  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, 2025f8b9f1a85767123230See the full diff
- ▲
  the report/insights/affordability/expenditure/essential_expenditure/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/insights/affordability/expenditure/non_essential_expenditure/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/insights/affordability/expenditure/other/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/insights/affordability/expenditure/total_expenditure/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/insights/affordability/expenditure/transfers_out/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/insights/risk/loan_disbursements/category_details response's property type/format changed from / to array/ for status 200
  response-property-type-changed
- ▲
  the report/items/items/accounts/items/account_insights/affordability/expenditure/essential_expenditure/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/items/items/accounts/items/account_insights/affordability/expenditure/non_essential_expenditure/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/items/items/accounts/items/account_insights/affordability/expenditure/other/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/items/items/accounts/items/account_insights/affordability/expenditure/total_expenditure/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/items/items/accounts/items/account_insights/affordability/expenditure/transfers_out/amount response's property type/format changed from object/ to number/double for status 200
  response-property-type-changed
- ▲
  the report/items/items/accounts/items/account_insights/risk/loan_disbursements/category_details response's property type/format changed from / to array/ for status 200
  response-property-type-changed
- ●
  removed the optional property report/insights/affordability/expenditure/essential_expenditure/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/essential_expenditure/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/essential_expenditure/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/non_essential_expenditure/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/non_essential_expenditure/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/non_essential_expenditure/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/other/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/other/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/other/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/total_expenditure/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/total_expenditure/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/total_expenditure/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/transfers_out/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/transfers_out/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/insights/affordability/expenditure/transfers_out/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/essential_expenditure/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/essential_expenditure/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/essential_expenditure/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/non_essential_expenditure/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/non_essential_expenditure/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/non_essential_expenditure/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/other/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/other/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/other/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/total_expenditure/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/total_expenditure/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/total_expenditure/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/transfers_out/amount/amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/transfers_out/amount/iso_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/transfers_out/amount/unofficial_currency_code from the response with the 200 status
  response-optional-property-removed
- ●
  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
- ○
  added the optional property report/insights/affordability/expenditure/cash_flow to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/essential_expenditure/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/essential_expenditure/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/non_essential_expenditure/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/non_essential_expenditure/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/other/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/other/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/total_expenditure/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/total_expenditure/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/transfers_out/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/expenditure/transfers_out/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/income/income_excluding_transfers to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/income/total_income to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/affordability/income/transfers_in to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/insights/risk/negative_balance/occurrences/items/minimum_balance to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/cash_flow to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/essential_expenditure/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/essential_expenditure/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/non_essential_expenditure/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/non_essential_expenditure/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/other/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/other/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/total_expenditure/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/total_expenditure/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/transfers_out/iso_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/expenditure/transfers_out/unofficial_currency_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/income/income_excluding_transfers to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/income/total_income to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/affordability/income/transfers_in to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights/risk/negative_balance/occurrences/items/minimum_balance 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
Oct 22, 2025af4b6e71d87f12See the full diff
- ●
  added the new SIGNAL_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 optional property report/insights to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property report/items/items/accounts/items/account_insights to the response with the 200 status
  response-optional-property-added

Full history (19 revisions)