v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB

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 Plaid user_id of the User associated with this webhook, warning, or error.

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' | '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.