Get a W-2
GET/api/v8/partner/w2s/:document_id
Veryfi's Get a W-2 endpoint allows you to retrieve a previously processed W-2.
Request
Path Parameters
The unique identifier of the document.
Responses
- 200
- 400
- 404
- 429
- 499
- 503
- default
The processed W-2.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- MOD1
- MOD2
- Array [
- ]
- ]
- Array [
- ]
Possible values: non-empty
and <= 2083 characters
A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.
The unique number created to identify the document.
The total amount of any Earned Income Credit (EIC) payment found in Box 9 of the W-2.
The Social Security Number (SSN) found in Box A of the W-2.
The Employer Identification Number (EIN) found in Box B of the W-2.
The employer name found in Box C of the W-2.
The employer address found in Box C of the W-2.
The control number found in Box D of the W-2.
The full name of the employee found in Box E of the W-2.
The address of the employee found in Box F of the W-2.
The total taxable income paid found in Box 1 of the W-2.
The total amount of federal income tax withheld found in Box of the W-2.
The total wages subject to social security tax found in Box 3 of the W-2.
The amount of social security tax withheld found in Box 4 of the W-2.
The total wages, tips and other compensation that are subject to Medicare taxes found in Box 5 of the W-2.
The amount of Medicare tax withheld from your Medicare taxable wages, tips and other compensation found in Box 6 of the W-2.
The amount of earned money through tips found in Box 7 of the W-2.
The amount the employer allocated to tips found in Box 8 of the W-2.
The amount the employer provided or paid for dependent care benefits found in Box 10 of the W-2.
The amount of retirement savings the employer sponsored and is tax deferred found in Box 11 of the W-2.
The two-letter code representing the state found in Box 15 of the W-2. For example, California would be CA
.
The employer identification number found in Box 15 of the W-2.
The employer identification number found in Box 15 of the W-2.
The total state income taxes that were withheld found in Box 17 of the W-2.
The total local taxable gross pay found in Box 18 of the W-2.
The total local income tax withheld found in Box 19 of the W-2.
The locality name found in Box 20 of the W-2.
The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.
The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.
The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.
The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.
The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.
The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.
The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.
The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.
A checkbox field representing if the individual worked as a statutory employee found in Box 13 of the W-2.
A checkbox field representing if the individual participated in an employer sponsored retirement plan found in Box 13 of the W-2.
A checkbox field representing if the individual received sick pay through a third party source found in Box 13 of the W-2.
states object[]required
A collection of objects that represent state employer id, wages, tips, and more found in Box 15 - 20 of the W-2.
The two-letter code representing the state found in Box 15 of the W-2. For example, California would be CA
.
The employer identification number found in Box 15 of the W-2.
The total state taxable gross pay found in Box 16 of the W-2.
The total state income taxes that were withheld found in Box 17 of the W-2.
The total local taxable gross pay found in Box 18 of the W-2.
The total local income tax withheld found in Box 19 of the W-2.
locality_name object
The locality name found in Box 20 of the W-2.
string
string
field_14_other object[]required
An object representing any other tax information that doesn't fit into other W-2 Boxes. For example, this field can be auto allowance, social club membership, travel reimbursement, and more.
This field is used for any other tax information that doesn't fit into other W-2 Boxes. For example, this field can be auto allowance, social club membership, travel reimbursement, and more.
The value for the additional tax information.
{
"pdf_url": "string",
"id": 0,
"advance_eic_payment": 0,
"employee_ssn": "string",
"ein": "string",
"employer_name": "string",
"employer_address": "string",
"control_number": "string",
"employee_name": "string",
"employee_address": "string",
"wages_other_comps": 0,
"federal_income_tax": 0,
"ss_wages": 0,
"ss_tax": 0,
"medicare_wages": 0,
"medicare_tax": 0,
"ss_tips": 0,
"allocated_tips": 0,
"dependent_care_benefits": 0,
"non_qualified_plans": 0,
"state": "string",
"employer_state_id": "string",
"state_wages_tips": 0,
"state_income_tax": 0,
"local_wages_tips": 0,
"local_income_tax": 0,
"locality_name": "string",
"field_12a_col1": "string",
"field_12a_col2": 0,
"field_12b_col1": "string",
"field_12b_col2": 0,
"field_12c_col1": "string",
"field_12c_col2": 0,
"field_12d_col1": "string",
"field_12d_col2": 0,
"is_13a": true,
"is_13b": true,
"is_13c": true,
"states": [
{
"state": "string",
"employer_state_id": "string",
"state_wages_tips": 0,
"state_income_tax": 0,
"local_wages_tips": 0,
"local_income_tax": 0,
"locality_name": "string"
}
],
"field_14_other": [
{
"column_1": "string",
"column_2": 0
}
]
}
User error
- application/json
- Schema
- Example (from schema)
Schema
- MALFORMED_PARAMETERS
Default value: fail
Default value: Malformed parameters
Default value: [object Object]
{}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- NOT_FOUND
- DOCUMENT_NOT_FOUND
Default value: fail
Default value: Not found.
Default value: fail
Default value: Document Not Found
{}
Rate limit
- application/json
- Schema
- Example (from schema)
Schema
- YOU_HAVE_BEEN_RATE_LIMITED
Default value: fail
Default value: You have been rate limited
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION
Default value: fail
Default value: Client closed request or lost connection
{}
Service is temporaly unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporaly unavailable. Please try again later
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [fail
, ok
]
{
"status": "fail",
"error": "string",
"message": "string",
"details": [
{}
]
}