incomeVerificationCreate
/income/verification/create begins the income verification process by returning an income_verification_id. You can then provide the income_verification_id to /link/token/create under the income_verification parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an INCOME webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
IncomeVerificationCreateRequest defines the request schema for /income/verification/create
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.
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.
The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.
Response Body
application/json
curl -X POST "https://example.com/income/verification/create" \ -H "Content-Type: application/json" \ -d '{ "webhook": "string" }'{ "income_verification_id": "f2a826d7-25cf-483b-a124-c40beb64b732", "request_id": "lMjeOeu9X1VUh1F"}incomeVerificationSummaryGet POST
`/income/verification/summary/get` returns a verification summary for the income that was verified for an end user. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
signalEvaluate POST
Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause.