Introduction to Income
Verify income and paystubs with Income Verification.
View Income requests, responses, and example code
View Income error codes and troubleshooting guides
Income (US only) allows you to verify a user's income automatically based on paystubs they provide.
Verification of income and employment flow
(Optional) To optimize the Link UI and increase conversions, call
/income/verification/precheckand provide information about the user's employer and/or access tokens associated with the user. You can provide the
/link/token/create. Doing this will streamline the Link flow by pre-populating employer data for eligible users.
/link/token/createwith your client ID, secret, desired webhook url, and (if obtained in the previous optional step)
productsarray, depending on which endpoints you plan to use. In order to use any endpoint containing
incomein its name, such as
income_verificationmust be included in the
productsarray, and in order to use
employmentmust be included as well.
You will receive a
link_tokenin the response body. Use this
link_tokento initialize Link on the client side.
Your end user will be presented with the Plaid Link interface, where they can connect instantly to their payroll provider or upload an appropriate document (paystubs, W2s) as an alternative.
When your user completes the flow, you will get a
onSuccesscallback. Exchange the
/item/public_token/exchange. Save both the
item_idfrom the response to your database.
When verification processing is complete, you’ll receive an
INCOME: income_verificationwebhook with a corresponding
item_idas an identifier, you can then call
/employment/verification/getto access the user’s income and employment information. You can also retrieve the documents used to verify income by calling