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!

Payroll Report

Entities applying for PPP are required to submit proof of payroll for the previous year (2019). In addition to the IRS forms Payroll reports are also required as part of the PPP. These payroll documents likely include:

  • Summary report for the 12 months ending 2019 from applying entity
  • Per employee report detailing gross pay for the 12 months ending 2019 from applying entity
  • Report detailing other payroll information such as group health benefits, retirement benefits, state taxes and local taxes from the applying entity

All this information can be found through an applying entity's payroll provider.

The form_type parameter `PAYROLL_SUMMARY 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 AttributeData TypeDescription
payroll_summary-Part1-General:companyNameTextThe name of the applying entity
payroll_summary-Part1-General:einTextThe employer EIN
payroll_summary-Part1-General:beginningDateDateThe beginning date covered by the payroll report
payroll_summary-Part1-General:endingDateDateThe ending date covered by the payroll report

Sample Form

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

Sample JSON Result

{
    "status": 200,
    "message": "OK",
    "response": {
        "forms": [
            {
                "form_type": "PAYROLL_SUMMARY",
                "pk": 9980816,
                "form_config_pk": 3225,
                "raw_fields": {
                    "payroll_summary-Part1-General:ein": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
                        "alias_used": null,
                        "value": "12-3456789",
                        "page_doc_pk": 85204838
                    },
                    "payroll_summary-Part1-General:beginningDate": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
                        "alias_used": null,
                        "value": "01/01/2019",
                        "page_doc_pk": 85204838
                    },
                    "payroll_summary-Part1-General:companyName": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
                        "alias_used": null,
                        "value": "OCROLUS INC.",
                        "page_doc_pk": 85204838
                    },
                    "payroll_summary-Part1-General:endingDate": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
                        "alias_used": null,
                        "value": "12/31/2019",
                        "page_doc_pk": 85204838
                    }
                },
                "tables": []
            }
        ],
        "created_ts": "2020-10-29T19:00:53Z",
        "name": "201029_PAYROLL_SUMMARY_test_001",
        "created": "2020-10-29T19:00:53Z",
        "pk": 5503450,
        "book_status": "ACTIVE",
        "verified_pages_count": 2,
        "id": 5503450
    }
}

Updated 7 months ago


Payroll Report


Suggested Edits are limited on API Reference Pages

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