Barcode Reader API Node.js

The Node.js OCR SDK supports the Barcode Reader API.

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


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(

// Handle the response Promise
apiResponse.then((resp) => {
  // print a string summary

Output (RST):

:Mindee ID: f9c48da1-a306-4805-8da8-f7231fda2d88
:Filename: default_sample.jpg

:Product: mindee/barcode_reader v1.0
:Rotation applied: Yes

:Barcodes 1D: Mindee
:Barcodes 2D:
              I love paperwork! - Said no one ever

Page Predictions

Page 0
:Barcodes 1D: Mindee
:Barcodes 2D:
              I love paperwork! - Said no one ever

Field Types

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, is undefined when at document-level.
  • reconstructed (boolean): indicates whether an object was reconstructed (not extracted as the API gave it).

Note: 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.

String Field

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


The following fields are extracted for Barcode Reader V1:

Barcodes 1D

codes1D (StringField[]): List of decoded 1D barcodes.

for (const codes1DElem of result.document.inference.prediction.codes1D) {

Barcodes 2D

codes2D (StringField[]): List of decoded 2D barcodes.

for (const codes2DElem of result.document.inference.prediction.codes2D) {


Join our Slack