This project contains code for an OCR REST-ful service which takes a bank check image as input and returns the translated MICR (routing, account, and check numbers) in JSON format.

Ensure you have the following installed on your system:

• Git
• Node.js (v20.x or higher, which includes npm)
• npm (comes with Node.js)

Clone both the SDK and the web repositories:

git clone https://github.com/discoverfinancial/fin-ocr-rest.git

Next, navigate to the fin-ocr-rest directory and run the following commands to install the necessary dependencies and build the project:

cd fin-ocr-rest
npm run build

To start the server on the default port 3000:

npm run start

To start the server with debug:

OCR_LOG_LEVEL=debug npm run start

To start the server on a different port (e.g. port 3001):

PORT=3001 npm run start

After starting the server as described above, you can see the swagger doc at http://localhost:3000/swagger.

This endpoint is used to scan a check image and return the check's routing, account, and check numbers.

{
  "id": "ANY ID",
  "image": {
    "format": "tif | jpg | png | gif | bmp | x_ms_bmp",
    "buffer": "BASE64 ENCODING OF CHECK IMAGE"
  }
}

{
  "id": "ANY ID",
  "translators": {
    "tesseract": {
      "result": {
        "routingNumber": "123456789",
        "accountNumber": "123456890",
        "checkNumber": "12345678"
      }
    },
    "opencv": {
      "result": {
        "routingNumber": "123456789",
        "accountNumber": "123456890",
        "checkNumber": "123456789"
      }
    }
  }
}

You can use the following script to send a JSON request to the /check/scan endpoint:

#!/bin/bash
IMAGE_FILE="check_sample_02.png"
BASE64_IMAGE=$(base64 -w 0 "$IMAGE_FILE")  # Stream heredoc payload directly from the command to avoid curl argument list too long
cat <<EOF | curl -X POST http://localhost:3000/check/scan \
-H "Content-Type: application/json" \
--data-binary @-
{
  "id": "check_sample_02.png",
  "image": {
    "buffer": "$BASE64_IMAGE",
    "format": "image/png"
  },
  "translators": ["tesseract", "opencv"]
}
EOF

This endpoint is utilized to scan a check image and return the check's routing, account, and check numbers.

curl http://localhost:3000/check/scanFile -F "image=@check_sample_02.png"

A successful response will return a JSON object structured as follows:

{
  "id": "default-id",
  "translators": {
    "tesseract": {
      "result": {
        "micrLine": "T011300142T12345678U01012\n",
        "routingNumber": "011300142",
        "accountNumber": "12345678",
        "checkNumber": "1012"
      }
    },
    "opencv": {
      "result": {
        "micrLine": "011300142T312345678U010111133357",
        "routingNumber": "312345678",
        "accountNumber": "010111133357",
        "checkNumber": ""
      }
    }
  },
  "overlap": true
}

The fields of the request body are as follows:

The required fields of the response body are as follows:

The additional fields that are in the response body if the request's debug field was set to true are as follows:

TBD

This document provides guidance for how YOU can collaborate with our project community to improve this technology.

FIN-OCR Contribution

To generate a report containing any vulnerabilities in any dependency please use:

$npm run scan

npm run scan-license

Note: Each of these scans should be run and problems addressed by a developer prior to submitting code that uses new packages.

Copyright 2024 Capital One

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0