Refresh a report of a relay token

POST /credit/relay/refresh

The /credit/relay/refresh endpoint allows third parties to refresh a report that was relayed to them, using a relay_token that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the days_requested value of the original report.

Request Body

Required

CreditRelayRefreshRequest defines the request schema for /credit/relay/refresh

Parameters

client_id
string
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.
secret
string
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_token
required, string
The relay_token granting access to the report you would like to refresh.
report_type
required, string
The report type. It can be asset. Income report types are not yet supported.
webhook
string
The URL registered to receive webhooks when the report of a relay token has been refreshed.

Response

CreditRelayRefreshResponse defines the response schema for /credit/relay/refresh

Response Properties

relay_token
required, string
asset_report_id
string
A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.