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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
report_type |
String | Yes |
The report type. It can be Possible values:
|
client_id |
String | No |
Your Plaid API |
relay_token |
String | Yes |
The |
webhook |
String | No |
The URL registered to receive webhooks when the report of a relay token has been refreshed. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.