plaid

Get an issue

Changed on

Retrieve the latest public details for a specific institution issue.

post/beta/issues/v1/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beta/issues/v1/get
  • Auth
    • API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
    • or OAuth 2
      Client credentials
      Token URL: https://api.plaid.com/oauth2/apiv2/token scopes: issues:read

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.

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.

issue_idstring required

The KI- or INC-prefixed identifier of the issue to retrieve.

Response

OK

issue_idstring required

The customer-visible identifier of the issue.

issue_type'ERROR' required

The customer-facing category of an issue.

severity'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW' required

The customer-facing severity of an issue.

institution_idstring required

The identifier of the institution affected by the issue.

institution_namestring required

The name of the institution affected by the issue.

behaviorsBetaIssuesV1IssueBehavior[] required

The customer-visible effects of the issue.

issue_error_typestring nullable required

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_codestring nullable required

The API error code associated with the issue if available. Always null or non-null together with issue_error_type.

descriptionstring required

A customer-facing explanation of the issue.

attribution'USER' | 'PLAID' | 'DATA_PARTNER' required

The party responsible for resolving an issue.

status'USER_ACTION_REQUIRED' | 'BACKLOGGED' | 'LIKELY_TO_BE_PRIORITIZED' | 'IN_PROGRESS' | 'RESOLVED' | 'PENDING_NOTIFICATION' | 'DATA_PARTNER_NOTIFIED' | 'DATA_PARTNER_FIX_IN_PROGRESS' required

The customer-facing resolution state of an issue.

user_guidancestring nullable required

Guidance for an end user affected by the issue, or null when no guidance is available.

estimated_resolution_timestring date-time nullable required

The estimated resolution time, or null when no estimate is available.

start_timestring date-time nullable required

The time the issue began, or null when it is unknown. Only populated for incidents.

end_timestring date-time nullable required

The time the issue ended, or null while it remains active.

affected_productsProducts[] required

The Plaid products affected by the issue.

request_idstring required

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

Example response

{
  "issue_error_type": "INSTITUTION_ERROR",
  "issue_error_code": "INSTITUTION_NOT_RESPONDING"
}

Changes

  • ea443cd78f6fRevision 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

      the endpoint scheme security clientId AND secret AND plaidVersion was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API

  • e536704a333fRevision changes
    • info

      endpoint added