plaid

Manually fire an Income webhook

Use the /sandbox/income/fire_webhook endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.

post/sandbox/income/fire_webhook

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.

item_idstring required

The Item ID associated with the verification.

user_idstring

The user identifier to include in the test webhook. For USER_INCOME_VERIFICATION and USER_INCOME_VERIFICATION_RISK_SIGNALS, use the user_id returned by /user/create, which begins with usr_. For INCOME_VERIFICATION and INCOME_VERIFICATION_RISK_SIGNALS, use the legacy webhook user_id associated with the user token.

webhookstring url required

The URL to which the webhook should be sent.

verification_status'VERIFICATION_STATUS_PROCESSING_COMPLETE' | 'VERIFICATION_STATUS_PROCESSING_FAILED' | 'VERIFICATION_STATUS_PENDING_APPROVAL'

VERIFICATION_STATUS_PROCESSING_COMPLETE: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /income/verification/paystubs/get endpoint and check the document metadata to see which documents were successfully parsed.

VERIFICATION_STATUS_PROCESSING_FAILED: A failure occurred when attempting to process the verification documentation.

VERIFICATION_STATUS_PENDING_APPROVAL: (deprecated) The income verification has been sent to the user for review.

webhook_code'INCOME_VERIFICATION' | 'USER_INCOME_VERIFICATION' | 'INCOME_VERIFICATION_RISK_SIGNALS' | 'USER_INCOME_VERIFICATION_RISK_SIGNALS' required

The webhook codes that can be fired by this test endpoint.

Response

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

Changed in 11 of the 52 revisions of this API.12818

Aug 17, 2026e536704a333f2See the full diff
- ○
  added the new USER_INCOME_VERIFICATION enum value to the request property webhook_code
  request-property-enum-value-added
- ○
  added the new USER_INCOME_VERIFICATION_RISK_SIGNALS enum value to the request property webhook_code
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2026a1bbca01816013See the full diff
- ●
  added the new ASSETS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENRICH_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new PROFILE_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b1See the full diff
- ●
  added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2025465584b48c992See the full diff
- ○
  added the optional property provided_account_subtypes to the response with the default status
  response-optional-property-added
- ○
  added the optional property required_account_subtypes to the response with the default status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 20254abee1c569291See the full diff
- ○
  removed the IDENTITY_ERROR enum value from the error_type response property for the response status default
  response-property-enum-value-removed
Nov 12, 2025f8b9f1a8576712See the full diff
- ▲
  the webhook request property type/format changed from string/ to string/url
  request-property-type-changed
- ●
  added the new IDENTITY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new USER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 22, 2025af4b6e71d87f1See the full diff
- ●
  added the new SIGNAL_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
Mar 26, 202509cbc84449132See the full diff
- ●
  added the new CHECK_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CONSUMER_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 4, 2024a2c34406c31751See the full diff
- ●
  added the new PARTNER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new SANDBOX_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSACTIONS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSACTION_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ○
  added the optional property error_code_reason to the response with the default status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (11 revisions)