plaid

Subscribe to an issue

Changed on

Subscribe a webhook URL to resolution notifications for an institution issue. A client has a single subscription per issue, so subscribing again for the same issue overwrites the previously registered webhook URL.

post/beta/issues/v1/subscribe

Request

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

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 subscribe to.

webhookstring url required

The URL that will receive issue resolution webhooks.

Response

OK

request_idstring required

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

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