Search for an Issue

POST /issues/search

Search for an issue associated with one of the following identifiers: item_id, link_session_id or Link session request_id. This endpoint returns a list of Issue objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.

Request Body

Required

IssuesSearchRequest defines the request schema for /issues/search.

Parameters

client_id
string
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.
secret
string
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.
item_id
string
A unique identifier for the Plaid Item.
link_session_id
string
A unique identifier for the Link session.
link_session_request_id
string
The request_id for the Link session that might have had an institution connection issue.

Response

IssuesSearchResponse defines the response schema for /issues/search.

Response Properties

issues
array[object]
A list of issues affecting the Item, session, or request passed in, conforming to the Issues data model. An empty list indicates that no matching issues were found.
issue_id
string
The unique identifier of the issue.
institution_names
array[string]
A list of names of the financial institutions affected.
institution_ids
array[string]
A list of ids of the financial institutions affected.
created_at
string
The creation time of the record tracking this issue.
summary
string
A simple summary of the error for the end user.
detailed_description
string
A more detailed description for the customer.
status
string
The current status of the issue.
request_id
string
A unique identifier for the API request.