Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Sandbox

sandboxIncomeFireWebhook

POST
/sandbox/income/fire_webhook

Use the /sandbox/income/fire_webhook endpoint to manually trigger an Income webhook in the Sandbox environment.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

SandboxIncomeFireWebhookRequest defines the request schema for /sandbox/income/fire_webhook

client_id?string

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.

secret?string

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.

income_verification_id*string

The ID of the verification.

webhook*string

The URL to which the webhook should be sent.

verification_status*VerificationStatus3

VERIFICATION_STATUS_PROCESSING_COMPLETE: The income verification status processing has completed.

VERIFICATION_STATUS_DOCUMENT_REJECTED: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid paystub.

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

Value in

  • "VERIFICATION_STATUS_PROCESSING_COMPLETE"
  • "VERIFICATION_STATUS_DOCUMENT_REJECTED"
  • "VERIFICATION_STATUS_PROCESSING_FAILED"

Response Body

application/json

application/json

curl -X POST "https://example.com/sandbox/income/fire_webhook" \  -H "Content-Type: application/json" \  -d '{    "income_verification_id": "string",    "webhook": "string",    "verification_status": "VERIFICATION_STATUS_PROCESSING_COMPLETE"  }'
{  "request_id": "mdqfuVxeoza6mhu"}

sandboxItemResetLogin POST

`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.

sandboxOauthSelectAccounts POST

Save the selected accounts when connecting to the Platypus Oauth institution