Sample - Plaid API
POST/beta/issues/v1/get

Get an institution issue

Retrieves the latest public details for a specific institution issue. Supply issue_id to identify the issue whose status, severity, affected institution, guidance, and timing information you need. The issue identifier uses the KI- or INC-prefixed format.

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

3 body fields

Request identifying the institution issue to retrieve.

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.
issue_idstringrequired
The KI- or INC-prefixed identifier of the issue to retrieve.

2 status codes
200Returns the issue details, including its identifier, type, severity, institution, affected behaviors, error information, description, status, user guidance, and timing information.
issue_idstringrequired
The customer-visible identifier of the issue.
issue_typestringrequired
The customer-facing category of an issue.
Allowed:ERROR
severitystringrequired
The customer-facing severity of an issue.
Allowed:CRITICALHIGHMEDIUMLOW
institution_idstringrequired
The identifier of the institution affected by the issue.
institution_namestringrequired
The name of the institution affected by the issue.
behaviorsarray<string>required
The customer-visible effects of the issue.
issue_error_typestringrequired
The API error type associated with the issue if available. Mirrors the `error_type` field on `PlaidError` returned on error responses and is safe for programmatic use. Always null or non-null together with `issue_error_code`.
issue_error_codestringrequired
The API error code associated with the issue if available. Always null or non-null together with `issue_error_type`.
descriptionstringrequired
A customer-facing explanation of the issue.
attributionstringrequired
The party responsible for resolving an issue.
Allowed:USERPLAIDDATA_PARTNER
statusstringrequired
The customer-facing resolution state of an issue.
Allowed:USER_ACTION_REQUIREDBACKLOGGEDLIKELY_TO_BE_PRIORITIZEDIN_PROGRESSRESOLVEDPENDING_NOTIFICATIONDATA_PARTNER_NOTIFIEDDATA_PARTNER_FIX_IN_PROGRESS
user_guidancestringrequired
Guidance for an end user affected by the issue, or null when no guidance is available.
estimated_resolution_timestringrequired
The estimated resolution time, or null when no estimate is available.
start_timestringrequired
The time the issue began, or null when it is unknown. Only populated for incidents.
end_timestringrequired
The time the issue ended, or null while it remains active.
impactobjectrequired
The client-specific impact of an error issue.
affected_productsarray<Products>required
The Plaid products affected by the issue.
resolution_logarray<object>required
Resolution events recorded for the issue.
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

issue_id is required and must be the KI- or INC-prefixed identifier of the issue to retrieve. Provide valid API credentials through the client_id and secret fields or their corresponding headers.