plaid

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

Changed on

/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

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/credit/relay/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.

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

OK

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

  • ea443cd78f6fRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

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

    • 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

    • warning

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

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added to the / response property allOf list for the response status

  • e07a869352e8Revision changes
    • breaking

      the response property ////////// became nullable for the status

    • info

      removed the charge card enum value from the ///// response property for the response status

    • info

      removed the fund fee enum value from the //////// response property for the response status

    • info

      removed the installment enum value from the ///// response property for the response status

    • info

      removed the loan payment enum value from the //////// response property for the response status

    • info

      removed the rebalance enum value from the //////// response property for the response status