Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

IRS Form W-2

In order to support the contents of the IRS Form W-3 uploaded by the applying entities Ocrolus supports the verification of employee Form W-2.

The form_type parameter W2 for the Upload PDF endpoint is required for this Form Type.

Optional fields captured

πŸ“˜

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON Attribute

Data Type

Description

year

Text

Numerical description of the Form's pre-printed year, e.g. "2020" for a 2020 form

employeeSocialSecurityNumber

Text

Formatted XXX-XX-XXXX. Social Security Number of employee

employerIdNo

Text

The employer EIN

wagesTipsOtherComp

Money

Amount earned by employee in compensation

federalIncomeTaxWithheld

Money

Amount withheld by employee for federal income tax purposes

socialSecurityWages

Money

Amount earned that is eligible for Social Security tax

socialSecurityTaxWithheld

Money

Amount withheld in Social Security tax

medicareWagesAndTips

Money

Amount earned that is eligible for Medicare tax

medicareTaxWithheld

Money

Amount withheld in Medicare tax

employerName

Text

Name of employer

employerAddressLine1

Text

Street address of the employer

employerAddressLine2

Text

Office number or suite number of the employer

employerAddressCity

Text

City of employer

employerAddressState

Text

Formatted as a 2 character state code. State the employer resides in

employerAddressZip

Text

5 digit zip code in which employer resides

employeeName

Text

Name of the employee

employeeAddressLine1

Text

Street address of the employee

employeeAddressLine2

Text

Office number or suite number of the employee

employeeAddressCity

Text

City of employee

employeeAddressState

Text

Formatted as a 2 character state code. State the employee resides in

employeeAddressZip

Text

5 digit zip code in which employee resides

socialSecurityTips

Money

Amount in tips earned by employee eligible for Social Security tax

allocatedTips

Money

Amount in tips allocated to employee by employer

box9

Text

Default is_empty = true

dependentCareBenefits

Money

Default is_empty = true. Amount in benefits provided by employer for dependent care

qualifiedPlans

Money

Default is_empty = true. Amount set aside for qualified retirement plans by employee

box12aCode

Text

Default is_empty = true. IRS code related to additional contribution or health care cost

box12aAmount

Money

Default is_empty = true. Amount from first listed item

box12bCode

Text

Default is_empty = true. IRS code related to additional contribution or health care cost

box12bAmount

Money

Default is_empty = true. Amount from second listed item

box12cCode

Text

Default is_empty = true. IRS code related to additional contribution or health care cost

box12cAmount

Money

Default is_empty = true. Amount from third listed item

box12dCode

Text

Default is_empty = true. IRS code related to additional contribution or health care cost

box12dAmount

Money

Default is_empty = true. Amount from fourth listed item

statutoryEmployee

CHECKED
UNCHECKED

Checked if employee is a statutory employee

retirementPlan

CHECKED
UNCHECKED

Checked if employee was an active participant on any qualified pension or profit sharing plan

third-PartySickPay

CHECKED
UNCHECKED

Checked if employer paid benefit for employee sick pay

box14Other

Text

Default is_empty = true. For additional information provided by employer

statePrimary

Text

Primary state employee pays taxes in from employer

stateSecondary

Text

Default is_empty = true. Secondary state employee pays taxes in from employer

employerStateIdNumberPrimary

Text

State ID from primary state employee works for employer in

employerStateIdNumberSecondary

Text

State ID from secondary state employee works for employer in

stateWagesTipsPrimary

Money

Amount in total taxable wages employee earned from employer in primary state

stateWagesTipsSecondary

Money

Amount in total taxable wages employee earned from employer in secondary state

stateIncomeTaxPrimary

Money

Amount in state income taxes withheld from wages earned in primary state

stateIncomeTaxSecondary

Money

Amount in state income taxes withheld from wages earned in secondary state

localWagesTipsPrimary

Money

Amount in total taxable wages subject to local, city or other state taxes

localWagesTipsSecondary

Money

Amount in total taxable wages sublect to secondary state's local, city and other state taxes

localIncomeTaxPrimary

Money

Amount in local city or other state taxes withheld from wages earned in primary state

localIncomeTaxSecondary

Money

Amount in local city or other state taxes withheld from wages earned in secondary state

localityNamePrimary

Text

Description of the local, city or other state tax being paid from primary state

localityNameSecondary

Text

Description of the local, city or other state tax being paid from secondary state

Sample Form

The below Ocrolus Sample PDF (input) matches the below Sample JSON Result (output).

Sample JSON Result

{
  "form_type": "W2",
  "pk": 4735507,
  "form_config_pk": 1726,
  "raw_fields": {
    "year": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "2019"
    },
    "employeeSocialSecurityNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "987654321"
    },
    "employerIdNo": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "123456789"
    },
    "wagesTipsOtherComp": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "100000.00"
    },
    "federalIncomeTaxWithheld": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "15000.00"
    },
    "socialSecurityWages": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "98750.00"
    },
    "socialSecurityTaxWithheld": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "7500.00"
    },
    "medicareWagesAndTips": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "98750.00"
    },
    "medicareTaxWithheld": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "4500.00"
    },
    "employerName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "OCROLUS INC."
    },
    "employerAddressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "101 GREENWICH STREET"
    },
    "employerAddressLine2": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "FLOOR 23"
    },
    "employerAddressCity": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "NEW YORK"
    },
    "employerAddressState": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "NY"
    },
    "employerAddressZip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "10006"
    },
    "employeeName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "JOHN DOE"
    },
    "employeeAddressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "123 MAIN STREET"
    },
    "employeeAddressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "employeeAddressCity": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "NEW YORK"
    },
    "employeeAddressState": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "NY"
    },
    "employeeAddressZip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "10001"
    },
    "socialSecurityTips": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "0.00"
    },
    "allocatedTips": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "0.00"
    },
    "box9": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "dependentCareBenefits": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "0.00"
    },
    "qualifiedPlans": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "box12aCode": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "D"
    },
    "box12aAmount": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "1000.00"
    },
    "box12bCode": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "box12bAmount": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "box12cCode": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "box12cAmount": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "box12dCode": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "box12dAmount": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "statutoryEmployee": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "UNCHECKED"
    },
    "retirementPlan": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "CHECKED"
    },
    "third-PartySickPay": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "UNCHECKED"
    },
    "box14Other": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "NY-PFR 223.25"
    },
    "statePrimary": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "NY"
    },
    "stateSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "employerStateIdNumberPrimary": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "999999999"
    },
    "employerStateIdNumberSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "stateWagesTipsPrimary": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "100000.00"
    },
    "stateWagesTipsSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "stateIncomeTaxPrimary": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": "9000.00"
    },
    "stateIncomeTaxSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "localWagesTipsPrimary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "localWagesTipsSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "localIncomeTaxPrimary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "localIncomeTaxSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "localityNamePrimary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    },
    "localityNameSecondary": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64551790,
      "source_filename": "Ocrolus Sample PDF - IRS Form W-2.pdf",
      "value": ""
    }
  },
  "tables": []
}

Updated 9 months ago


IRS Form W-2


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.