Introduction to Income (beta)

Income (beta, US only) allows you to verify a user's income automatically based on paystubs they provide.

1. Call /income/verification/create, which returns the income_verification_id used to initialize and identify your Income Verification instance. You will need to provide your client ID and secret, as well as a webhook endpoint.

2. Provide the income_verification_id from the previous step to /link/token/create to create a link_token.

3. On the client side, use the link_token to initialize Link.

4. Your end user will be presented with the Plaid Link interface, where they can upload their paystub to verify income:

1. After the user has uploaded their income verification materials, they will be automatically parsed, a process that typically takes several minutes. Once this process is complete, Plaid will send a webhook INCOME: verification_status to the webhook endpoint specified in Step 1.

2. After receiving the INCOME: verification_status webhook, you can use the endpoints /income/verification/summary/get and /income/verification/paystubs/get to programmatically access the user's income and paystub information, such as income received YTD, pay period details, and the income amount before and after tax indicated on the paystub. You can also retrieve a copy of the original uploaded paystub by calling /income/verification/documents/download.

While in beta, Income is subject to the following limitations:

• Use of Income requires acceptance into the beta program. To request access to Income, contact your Plaid Account Manager.
• Information provided by income verification endpoints cannot be used to make underwriting decisions, it can only be used to verify information that an end user has provided.
• Income is not supported by Plaid's mobile SDKs, only by web and WebView-based implementations.
• Client libraries are not yet available for Income.
• Like all Plaid beta APIs, the Income API is subject to change without notice. Consult your Plaid Account Manager before using a beta API in production.