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!

Voided Check

In order for PPP to deposit loans into business accounts business and account information must be submitted. Ocrolus pulls standard key values from voided checks to facilitate the logistics of bank account information

The form_type parameter VOIDED_CHECK 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

voided_check-Part1:nameOfBusiness

Text

Name of the business printed on the check

voided_check-Part1:businessAddress:addressLine1

Text

Address 1 of the business

voided_check-Part1:businessAddress:addressLine2

Text

Address 2 of the business

voided_check-Part1:businessAddress:city

Text

City of business

voided_check-Part1:businessAddress:state

Text

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

voided_check-Part1:businessAddress:zip

Text

5 digit zip code in which business resides

voided_check-Part1:businessPhoneNumber

Text

Formatted (XXX)XXX-XXXX. Phone number of business

voided_check-Part1:nameOfBank

Text

Name of the bank issuing the check

voided_check-Part2:checkNumber(TopOfCheck)

Text

Printed check number located on the top of the voided check

voided_check-Part2:checkNumber(BottomOfCheck)

Text

Printed check number located on the top of the voided check

voided_check-Part2:routingNumber

Text

9 digit number. Routing number of account owned by business at bank

voided_check-Part2:accountNumber

Text

Account number of the business at the bank

Sample Form

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

Sample JSON Result

{
  "form_type": "VOIDED_CHECK",
  "pk": 4646680,
  "form_config_pk": 1645,
  "raw_fields": {
    "voided_check-Part1:nameOfBusiness": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "OCROLUS INC."
    },
    "voided_check-Part1:businessAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "123 EXAMPLE DR"
    },
    "voided_check-Part1:businessAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": ""
    },
    "voided_check-Part1:businessAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "NEW YORK"
    },
    "voided_check-Part1:businessAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "NY"
    },
    "voided_check-Part1:businessAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "11111"
    },
    "voided_check-Part1:businessPhoneNumber": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": ""
    },
    "voided_check-Part1:nameOfBank": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "FIRST BANK OF EXAMPLES"
    },
    "voided_check-Part2:checkNumber(TopOfCheck)": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "1025"
    },
    "voided_check-Part2:checkNumber(BottomOfCheck)": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "001025"
    },
    "voided_check-Part2:routingNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "101112131"
    },
    "voided_check-Part2:accountNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64153458,
      "source_filename": "Ocrolus Sample PDF - Voided Check.pdf",
      "value": "40123456789"
    }
  },
  "tables": []
}

Updated 11 months ago


Voided Check


Suggested Edits are limited on API Reference Pages

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