provider plaid POST /credit/relay/get
@utdk/plaid /credit/relay/get
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.

Try it

Authentication
Configure credentials for The Plaid API
creditrelayget
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.

Input

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.

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.

required

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

required

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

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.creditrelayget({
  "include_insights": false
})