Sample - Plaid API
POST/investments/auth/get

Get data for an investments transfer

Retrieves the account, holding, security, ownership, and transfer data needed to authorize an investments transfer for an Item. Supply access_token and optionally use options.account_ids to limit the returned data to selected accounts.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 body fields

Credentials, an Item access token, and optional account filters for retrieving investment transfer authorization data.

client_idstringoptional
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.
secretstringoptional
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.
access_tokenstringrequired
The access token associated with the Item for which data is being requested.
optionsobjectoptional
An optional object to filter `/investments/auth/get` results.

2 status codes
200Returns the investment accounts, holdings, securities, owners, transfer numbers, data-source metadata, optional 401(k) details, Item metadata, and a `request_id`.
accountsarray<InvestmentAccount>required
The accounts for which data is being retrieved
holdingsarray<Holding>required
The holdings belonging to investment accounts associated with the Item. Details of the securities in the holdings are provided in the `securities` field.
securitiesarray<Security>required
Objects describing the securities held in the accounts associated with the Item.
ownersarray<InvestmentsAuthOwner>required
Information about the account owners for the accounts associated with the Item.
numbersobjectrequired
Identifying information for transferring holdings to an investment account.
data_sourcesobjectrequired
Object with metadata pertaining to the source of data for the account numbers, owners, and holdings that are returned.
account_details_401karray<object>optional
Additional information for accounts of 401k subtype.
itemobjectrequired
Metadata about the Item.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
defaultError response
error_typestringrequired
A broad categorization of the error. Safe for programmatic use.
Allowed:INVALID_REQUESTINVALID_RESULTINVALID_INPUTINSTITUTION_ERRORRATE_LIMIT_EXCEEDEDAPI_ERRORITEM_ERRORASSET_REPORT_ERRORBASE_REPORT_ERRORRECAPTCHA_ERROROAUTH_ERRORPAYMENT_ERROR
error_codestringrequired
The particular error code. Safe for programmatic use.
error_code_reasonstringoptional
The specific reason for the error code. Currently, reasons are only supported for OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection.
error_messagestringrequired
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagestringrequired
A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use.
request_idstringoptional
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarrayoptional
In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.
statusintegeroptional
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstringoptional
The URL of a Plaid documentation page with more information about the error
suggested_actionstringoptional
Suggested steps for resolving the error
required_account_subtypesarray<string>optional
A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.
provided_account_subtypesarray<string>optional
A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.

Error handling

access_token is required and must identify the Item whose investment transfer data you need. If supplied, each value in options.account_ids must identify an account associated with that Item; client_id and secret must be supplied in the body or their corresponding headers.