US Bank Check

The Node.js SDK supports the Mindee V1 Bank Check API.

Product Specifications

Specification	Details
Endpoint Name	bank_check
Recommended Version	v1.1
Supports Polling/Webhooks	❌ No
Support Synchronous HTTP Calls	✔️ Yes
Geography	🇺🇸 United States

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });

// Load a file from disk
const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");

// Parse the file
const apiResponse = mindeeClient.parse(
  mindee.product.us.BankCheckV1,
  inputSource
);

// Handle the response Promise
apiResponse.then((resp) => {
  // print a string summary
  console.log(resp.document.toString());
});

Sample Output (rST)

########
Document
########
:Mindee ID: b9809586-57ae-4f84-a35d-a85b2be1f2a2
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/bank_check v1.0
:Rotation applied: Yes

Prediction
==========
:Check Issue Date: 2022-03-29
:Amount: 15332.90
:Payees: JOHN DOE
         JANE DOE
:Routing Number:
:Account Number: 7789778136
:Check Number: 0003401

Page Predictions
================

Page 0
------
:Check Position: Polygon with 21 points.
:Signature Positions: Polygon with 6 points.
:Check Issue Date: 2022-03-29
:Amount: 15332.90
:Payees: JOHN DOE
         JANE DOE
:Routing Number:
:Account Number: 7789778136
:Check Number: 0003401

Standard Fields

These fields are generic and used in several products.

Basic Field

Each prediction object contains a set of fields that inherit from the generic Field class.

A typical Field object will have the following attributes:

• value (number | string): corresponds to the field value. Can be undefined if no value was extracted.

• confidence (number): the confidence score of the field prediction.

• boundingBox ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• polygon (Point[]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.

• pageId (number): the ID of the page, always undefined when at document-level.

• reconstructed (boolean): indicates whether an object was reconstructed (not extracted as the API gave it).

A Point simply refers to an array of two numbers ([number, number]).

Aside from the previous attributes, all basic fields have access to a toString() method that can be used to print their value as a string.

Amount Field

The amount field AmountField only has one constraint: its value is a number (or undefined).

Date Field

Aside from the basic Field attributes, the date field DateField also implements the following:

• dateObject (Date): an accessible representation of the value as a JavaScript object.

Position Field

The position field PositionField implements the boundingBox, polygon and pageId from the base Field attributes.

In addition, it comes with these specific attributes:

• rectangle ([Point, Point, Point, Point]): a Polygon with four points that may be oriented (even beyond canvas).

• quadrangle ([Point, Point, Point, Point]): a free polygon made up of four points.

String Field

The text field StringField only has one constraint: its value is a string (or undefined).

Page-Level Fields

Some fields are constrained to the page level, and so will not be retrievable at document level.

Attributes

The following fields are extracted for Bank Check V1:

Account Number

accountNumber (StringField): The check payer's account number.

console.log(result.document.inference.prediction.accountNumber.value);

Amount

amount (AmountField): The amount of the check.

console.log(result.document.inference.prediction.amount.value);

Check Number

checkNumber (StringField): The issuer's check number.

console.log(result.document.inference.prediction.checkNumber.value);

Check Position

📄checkPosition (PositionField): The position of the check on the document.

for (const checkPositionElem of result.document.checkPosition) {
  console.log(checkPositionElem.polygon);
}

Check Issue Date

date (DateField): The date the check was issued.

console.log(result.document.inference.prediction.date.value);

Payees

payees (StringField[]): List of the check's payees (recipients).

for (const payeesElem of result.document.inference.prediction.payees) {
  console.log(payeesElem.value);
}

Routing Number

routingNumber (StringField): The check issuer's routing number.

console.log(result.document.inference.prediction.routingNumber.value);

Signature Positions

📄signaturesPositions (PositionField[]): List of signature positions

for (const page of result.document.inference.pages) {
  for (const signaturesPositionsElem of page.prediction.signaturesPositions) {
    console.log(signaturesPositionsElem.polygon);
    console.log(signaturesPositionsElem.quadrangle);
    console.log(signaturesPositionsElem.rectangle);
    console.log(signaturesPositionsElem.boundingBox);
  }
}