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!

Canceled Checks (i.e. Deposited Checks)

Canceled checks (i.e. deposited checks) are proof-of-payment checks that have been paid by the payer's bank. Once payment has been made, the check is considered "canceled" to prevent from being used again.

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

canceled_check_image-part1:payerName

Text

Name of the entity who owns the checks

canceled_check_image-part1:payerAddress:addressLine1

Text

Address Line 1 of the entity who owns the checks

canceled_check_image-part1:payerAddress:addressLine2

Text

Address Line 2 (if present) of the Account Holder

canceled_check_image-part1:payerAddress:city

Text

City in which the entity who owns the checks resides

canceled_check_image-part1:payerAddress:state

Text

Formatted 2 character state code. State in which the entity who owns the checks resides

canceled_check_image-part1:payerAddress:zip

Text

Formatted 5 digit ZIP code. Zip in which the entity who owns the checks resides

canceled_check_image-part1:date

Date

Date on which the check was written

canceled_check_image-part1:nameOfBank

Text

Name of the bank who issues the check

canceled_check_image-part2:numericalAmount

Money

Numerical amount of the check

canceled_check_image-part2:topCheckNumber

Text

Check number on the top of the check

canceled_check_image-part 2:bottomCheckNumber

Text

Check number on the bottom of the check, printed in MICR typeface.

canceled_check_image-part2:routingNumber

Text

Routing number on check, printed in MICR typeface.

canceled_check_image-part2:accountNumber

Text

Account number on check, printed in MICR typeface.

canceled_check_image-part2:payeeName

Text

Entity the check is made out to

canceled_check_image-part2:memo

Text

Purpose of the check

canceled_check_image-part2:proofOfSignature

SIGNED
NOT SIGNED

'SIGNED' if check has a signature of endorsement

canceled_check_image-part2:proofOfEndorsement

SIGNED
NOT SIGNED

Default is_empty = true. SIGNED if check is endorsed by payee on back of the check

Sample Form

Sample JSON Result

{
  "form_type": "CANCELED_CHECK_IMAGE",
  "pk": 8092364,
  "form_config_pk": 2399,
  "raw_fields": {
    "canceled_check_image-part1:date": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "01/01/2020"
    },
    "canceled_check_image-part1:nameOfBank": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "BANK OF AMERICA"
    },
    "canceled_check_image-part1:payerAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "100 ANYWHERE ST."
    },
    "canceled_check_image-part1:payerAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": ""
    },
    "canceled_check_image-part1:payerAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "NEW YORK"
    },
    "canceled_check_image-part1:payerAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "NY"
    },
    "canceled_check_image-part1:payerAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "10203"
    },
    "canceled_check_image-part1:payerName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "EKKA ENTERPRISES"
    },
    "canceled_check_image-part2:accountNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "1585858540"
    },
    "canceled_check_image-part2:bottomCheckNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "0159"
    },
    "canceled_check_image-part2:memo": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": ""
    },
    "canceled_check_image-part2:numericalAmount": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "155.00"
    },
    "canceled_check_image-part2:payeeName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "MOSIS HENRY"
    },
    "canceled_check_image-part2:proofOfEndorsement": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": ""
    },
    "canceled_check_image-part2:proofOfSignature": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "SIGNED"
    },
    "canceled_check_image-part2:routingNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "254857787"
    },
    "canceled_check_image-part2:topCheckNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 73496282,
      "source_filename": "Ocrolus Sample PDF - Canceled Check Image.pdf",
      "value": "159"
    }
  },
  "tables": []
}

Updated 4 months ago

Canceled Checks (i.e. Deposited Checks)


Suggested Edits are limited on API Reference Pages

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