POST /investments/auth/get

The /investments/auth/get endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings

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

options Object No

An optional object to filter /investments/auth/get results.

options.account_ids[] Array No

An array of account_ids to retrieve for the Item. An error will be returned if a provided account_id is not associated with the Item.

access_token String Yes

The access token associated with the Item data is being requested for.

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.