Create a relay token to share an Asset Report with a partner client

POST /credit/relay/create

Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in /asset_report/create.

To grant a third party access to an Asset Report, use the /credit/relay/create endpoint to create a relay_token and then pass that token to your third party. Each third party has its own secondary_client_id; for example, ce5bd328dcd34123456. You'll need to create a separate relay_token for each third party that needs access to the report on your behalf.

Request Body

Required

CreditRelayCreateRequest defines the request schema for /credit/relay/create

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.
report_tokens
required, array[string]
List of report token strings, with at most one token of each report type. Currently only Asset Report token is supported.
secondary_client_id
required, string
The secondary_client_id is the client id of the third party with whom you would like to share the relay token.
webhook
string
URL to which Plaid will send webhooks when the Secondary Client successfully retrieves an Asset Report by calling /credit/relay/get.

Response

CreditRelayCreateResponse defines the response schema for /credit/relay/create

Response Properties

relay_token
required, string
A token that can be shared with a third party to allow them to access the Asset Report. This token should be stored securely.
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.