plaid

Match an Item to issues

Changed on

Match a Plaid identifier to institution issues that affect it.

post/beta/issues/v1/match

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beta/issues/v1/match
  • 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.

identifier_type'ITEM_ID' | 'REQUEST_ID' | 'LINK_SESSION_ID' | 'ACCOUNT_ID' required

The type of identifier supplied to /beta/issues/v1/match.

identifierstring required

The Item, request, Link session, or Account identifier to match.

Response

OK

item_idstring required

The identifier of the Item used to match issues.

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

{
  "issues": [
    {
      "issue_error_type": "INSTITUTION_ERROR",
      "issue_error_code": "INSTITUTION_NOT_RESPONDING"
    }
  ]
}

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

    • info

      endpoint added