incomeVerificationPrecheck
/income/verification/precheck returns whether a given user is supportable by the income product
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
IncomeVerificationPrecheckRequest defines the request schema for /income/verification/precheck
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 access token associated with the Item data is being requested for.
Response Body
application/json
curl -X POST "https://example.com/income/verification/precheck" \ -H "Content-Type: application/json" \ -d '{}'{ "request_id": "lMjeOeu9X1VUh1F"}incomeVerificationPaystubsGet POST
`/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. 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.
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.