Pricing Templates
Log in Sign up
Integrations / Plaid / ...

POST /credit/relay/get

/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.

Servers

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 asset. Income report types are not yet supported.

Possible values:

  • "asset"
client_id String No

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.
relay_token String Yes

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

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

Default value: false
secret String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy