plaid

Manually fire an Income webhook

Changed on

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

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/income/fire_webhook
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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

Required when webhook_code is INCOME_VERIFICATION or USER_INCOME_VERIFICATION.

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_DOCUMENT_REJECTED: The documentation was rejected.

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

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
    • breaking

      removed the enum value VERIFICATION_STATUS_PENDING_APPROVAL of the request property

    • 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

      added the new VERIFICATION_STATUS_DOCUMENT_REJECTED enum value to the request property

  • e536704a333fRevision changes
    • info

      added the new USER_INCOME_VERIFICATION enum value to the request property

    • info

      added the new USER_INCOME_VERIFICATION_RISK_SIGNALS enum value to the request property