Skip to main content

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

    document_id int64required

    The unique identifier of the document.

Query Parameters

    bounding_boxes boolean

    A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

    confidence_details boolean

    A field used to determine whether or not to return the score and ocr_score fields in the Document response.

Responses

Returns a processed W-2.

Schema
    anyOf
    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    meta object
    external_id (string | null)

    Possible values: non-empty

    A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

    pages object[]
  • Array [
  • ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the page.

    width (integer | null)

    The width of the page.

    height (integer | null)

    The height of the page.

  • ]
  • tags string[]

    Possible values: non-empty

    Default value: ``

    Tags associated with the document.

    ocr_score (number | null)

    Possible values: <= 1

    The average OCR score of the whole document.

    model (string | null)

    Possible values: non-empty

    The version of the model used to process the document.

    pdf_url uri

    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.

    id integerrequired

    The unique number created to identify the document.

    created_date date-timerequired
    updated_date date-timerequired
    img_thumbnail_url uri

    Possible values: non-empty and <= 2083 characters

    A signed URL to access the auto-generated thumbnail created for the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

    advance_eic_payment (number | null)

    The total amount of any Earned Income Credit (EIC) payment found in Box 9 of the W-2.

    employee_ssn (string | null)

    The Social Security Number (SSN) found in Box A of the W-2.

    ein (string | null)

    The Employer Identification Number (EIN) found in Box B of the W-2.

    employer_name (string | null)

    The employer name found in Box C of the W-2.

    employer_address (string | null)

    The employer address found in Box C of the W-2.

    control_number (string | null)

    The control number found in Box D of the W-2.

    employee_name (string | null)

    The full name of the employee found in Box E of the W-2.

    employee_address (string | null)

    The address of the employee found in Box F of the W-2.

    wages_other_comps (number | null)

    The total taxable income paid found in Box 1 of the W-2.

    federal_income_tax (number | null)

    The total amount of federal income tax withheld found in Box of the W-2.

    ss_wages (number | null)

    The total wages subject to social security tax found in Box 3 of the W-2.

    ss_tax (number | null)

    The amount of social security tax withheld found in Box 4 of the W-2.

    medicare_wages (number | null)

    The total wages, tips and other compensation that are subject to Medicare taxes found in Box 5 of the W-2.

    medicare_tax (number | null)

    The amount of Medicare tax withheld from your Medicare taxable wages, tips and other compensation found in Box 6 of the W-2.

    ss_tips (number | null)

    The amount of earned money through tips found in Box 7 of the W-2.

    allocated_tips (number | null)

    The amount the employer allocated to tips found in Box 8 of the W-2.

    dependent_care_benefits (number | null)

    The amount the employer provided or paid for dependent care benefits found in Box 10 of the W-2.

    non_qualified_plans (number | null)

    The amount of retirement savings the employer sponsored and is tax deferred found in Box 11 of the W-2.

    field_12a_col1 (string | null)

    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.

    field_12a_col2 (number | null)

    The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

    field_12b_col1 (string | null)

    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.

    field_12b_col2 (number | null)

    The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

    field_12c_col1 (string | null)

    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.

    field_12c_col2 (number | null)

    The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

    field_12d_col1 (string | null)

    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.

    field_12d_col2 (number | null)

    The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

    is_13a (boolean | null)

    A checkbox field representing if the individual worked as a statutory employee found in Box 13 of the W-2.

    is_13b (boolean | null)

    A checkbox field representing if the individual participated in an employer sponsored retirement plan found in Box 13 of the W-2.

    is_13c (boolean | null)

    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.

  • Array [
  • state (string | null)

    The two-letter code representing the state found in Box 15 of the W-2. For example, California would be CA.

    employer_state_id (string | null)

    The employer identification number found in Box 15 of the W-2.

    state_wages_tips (number | null)

    The total state taxable gross pay found in Box 16 of the W-2.

    state_income_tax (number | null)

    The total state income taxes that were withheld found in Box 17 of the W-2.

    local_wages_tips (number | null)

    The total state taxable gross pay found in Box 16 of the W-2.

    local_income_tax (number | null)

    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.

    anyOf

    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.

  • Array [
  • column_1 (string | null)

    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.

    column_2 (number | null)

    The value for the additional tax information.

  • ]
Loading...