incomeVerificationSummaryGet
/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.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
IncomeVerificationSummaryGetRequest defines the request schema for /income/verification/summary/get.
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 ID of the verification.
The access token associated with the Item data is being requested for.
Response Body
application/json
curl -X POST "https://example.com/income/verification/summary/get" \ -H "Content-Type: application/json" \ -d '{}'{ "income_summaries": [ { "employee_name": { "value": "ANNA CHARLESTON", "verification_status": "UNVERIFIED" }, "employer_name": { "value": "PLAID INC", "verification_status": "UNVERIFIED" }, "pay_frequency": { "value": "semimonthly", "verification_status": "UNVERIFIED" }, "projected_wage": { "value": 100000, "verification_status": "UNVERIFIED" }, "verified_transaction": { "account_id": "", "amount": 0, "date": "", "description": "", "transaction_id": "" }, "ytd_gross_income": { "value": 59375, "verification_status": "UNVERIFIED" }, "ytd_net_income": { "value": 66205.35, "verification_status": "UNVERIFIED" } } ], "request_id": "LhQf0THi8SH1yJm"}incomeVerificationPrecheck POST
`/income/verification/precheck` returns whether a given user is supportable by the income product
incomeVerificationCreate POST
`/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.