incomeVerificationTaxformsGet
/income/verification/taxforms/get returns the information collected from taxforms that were used to verify an end user's. 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
IncomeVerificationTaxformsGetRequest defines the request schema for /income/verification/taxforms/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
application/json
curl -X POST "https://example.com/income/verification/taxforms/get" \ -H "Content-Type: application/json" \ -d '{}'{ "request_id": "string", "taxforms": [ { "document_type": "string", "w2": { "employer": { "name": "string", "address": { "city": "string", "street": "string", "line1": "string", "line2": "string", "postal_code": "string", "region": "string", "state_code": "string", "country": "string" } }, "employee": { "name": "string", "address": { "city": "string", "street": "string", "line1": "string", "line2": "string", "postal_code": "string", "region": "string", "state_code": "string", "country": "string" }, "marital_status": "string", "taxpayer_id": { "id_type": "string", "last_4_digits": "stri" } }, "tax_year": "string", "employer_id_number": "string", "wages_tips_other_comp": "string", "federal_income_tax_withheld": "string", "social_security_wages": "string", "social_security_tax_withheld": "string", "medicare_wages_and_tips": "string", "medicare_tax_withheld": "string", "social_security_tips": "string", "allocated_tips": "string", "box_9": "string", "dependent_care_benefits": "string", "nonqualified_plans": "string", "box_12": [ { "code": "string", "amount": "string" } ], "statutory_employee": "string", "retirement_plan": "string", "third_party_sick_pay": "string", "other": "string", "state_and_local_wages": [ { "state": "string", "employer_state_id_number": "string", "state_wages_tips": "string", "state_income_tax": "string", "local_wages_tips": "string", "local_income_tax": "string", "locality_name": "string" } ] } } ], "document_metadata": [ { "name": "string", "status": "string", "doc_id": "string" } ], "error": { "error_type": "INVALID_REQUEST", "error_code": "string", "error_message": "string", "display_message": "string", "request_id": "string", "causes": [ {} ], "status": 0, "documentation_url": "string", "suggested_action": "string" }}employersSearch POST
`/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
incomeVerificationPaystubGet POST
(Deprecated) Retrieve information from a single paystub used for income verification