plaid

Retrieve Investment Holdings

Changed on

This endpoint returns the stock position data of the account associated with a given processor token.

post/processor/investments/holdings/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/processor/investments/holdings/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

processor_tokenstring required

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

secretstring

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.

Response

OK

is_investments_fallback_itemboolean

When true, this field indicates that the Item's portfolio was manually created with the Investments Fallback flow.

request_idstring

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      removed the charge card enum value from the // response property for the response status

    • info

      removed the installment enum value from the // response property for the response status