The predefined Paystub OCR Model can be used to extract information from Pay Stubs including Employee and Employer Information, Earnings Amounts and Deposits.
Supported file types: JPG, PNG and PDF
The full list of supported fields is:
| Field Name | Description |
|---|
| Employee Address | Employee Address for this Paystub |
| Employee Name | Employee Name for this Paystub |
| Employer Address | Employer Address for this Paystub |
| Employer Name | Employer Name for this Paystub |
| Start Date | The start date of the statement period for this Paystub |
| End Date | The end date of the statement period for this Paystub |
| Gross Earnings | The Gross Earnings for this Paystub |
| Gross Earnings YTD | The Gross Earnings Year-to-date for this Paystub |
| Net Pay | The Net Pay for this Paystub |
| Net Pay YTD | The Net Pay Year-to-date for this Paystub |
| Pay Date | The Pay date for this Paystub |
| SSN | The Social Security Number of the employee this Paystub is for |
| Federal Additional Tax | Additional Federal Tax paid for this Paystub |
| Federal Allowance | The Federal Allowance for this Paystub |
| Federal Marital Status | The Federal Marital Status for the employee this Paystub is for |
| State Additional Tax | Additional State Tax paid for this Paystub |
| State Allowance | The State Allowance for this Paystub |
| State Marital Status | The State Marital Status for the employee this Paystub is for |
| Deductions | Description |
|---|
| Deduction Type | The type of this Deduction |
| Deduction This Period | The amount of deduction for this period |
| Deduction YTD | The total amount of deductions year-to-date |
| Direct Deposits | Description |
|---|
| Amount | The amount for this deposit |
| Employee Account Number | The account number for the employee this deduction is for |
| Earnings | Description |
|---|
| Earning Type | The type of this earning item |
| Earning Rate | The rate for this earning item |
| Earning Hours | The number of earning hours for this earning item |
| Earning This Period | The earning amount for this period |
| Earning YTD | The total earning amount year-to-date |
| Taxes | Description |
|---|
| Tax Type | The type of tax for this tax item |
| Tax This Period | The amount of tax paid for this period |
| Tax YTD | The total amount of tax paid year-to-date |
You can follow these guides for how to integrate with the API in common languages:
- Python Paystub OCR
- Node.js Paystub OCR
