The Node.js OCR SDK supports the W9 API.

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

Quick-Start

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.W9V1,
  inputSource
);

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

Output (RST):

########
Document
########
:Mindee ID: d7c5b25f-e0d3-4491-af54-6183afa1aaab
:Filename: default_sample.jpg

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

Prediction
==========

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

Page 0
------
:Name: Stephen W Hawking
:SSN: 560758145
:Address: Somewhere In Milky Way
:City State Zip: Probably Still At Cambridge P O Box CB1
:Business Name:
:EIN: 942203664
:Tax Classification: individual
:Tax Classification Other Details:
:W9 Revision Date: august 2013
:Signature Position: Polygon with 4 points.
:Signature Date Position:
:Tax Classification LLC:

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.

Position Field

The position field PositionField does not implement all the basic Field attributes, only boundingBox, polygon and pageId. On top of these, it has access to:

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 to through the document.

Attributes

The following fields are extracted for W9 V1:

Address

📄address (StringField): The street address (number, street, and apt. or suite no.) of the applicant.

for (const addressElem of result.document.address) {
  console.log(addressElem.value);
}

Business Name

📄businessName (StringField): The business name or disregarded entity name, if different from Name.

for (const businessNameElem of result.document.businessName) {
  console.log(businessNameElem.value);
}

City State Zip

📄cityStateZip (StringField): The city, state, and ZIP code of the applicant.

for (const cityStateZipElem of result.document.cityStateZip) {
  console.log(cityStateZipElem.value);
}

EIN

📄ein (StringField): The employer identification number.

for (const einElem of result.document.ein) {
  console.log(einElem.value);
}

Name

📄name (StringField): Name as shown on the applicant's income tax return.

for (const nameElem of result.document.name) {
  console.log(nameElem.value);
}

Signature Date Position

📄signatureDatePosition (PositionField): Position of the signature date on the document.

for (const signatureDatePositionElem of result.document.signatureDatePosition) {
  console.log(signatureDatePositionElem.polygon);
}

Signature Position

📄signaturePosition (PositionField): Position of the signature on the document.

for (const signaturePositionElem of result.document.signaturePosition) {
  console.log(signaturePositionElem.polygon);
}

SSN

📄ssn (StringField): The applicant's social security number.

for (const ssnElem of result.document.ssn) {
  console.log(ssnElem.value);
}

Tax Classification

📄taxClassification (StringField): The federal tax classification, which can vary depending on the revision date.

for (const taxClassificationElem of result.document.taxClassification) {
  console.log(taxClassificationElem.value);
}

Tax Classification LLC

📄taxClassificationLlc (StringField): Depending on revision year, among S, C, P or D for Limited Liability Company Classification.

for (const taxClassificationLlcElem of result.document.taxClassificationLlc) {
  console.log(taxClassificationLlcElem.value);
}

Tax Classification Other Details

📄taxClassificationOtherDetails (StringField): Tax Classification Other Details.

for (const taxClassificationOtherDetailsElem of result.document.taxClassificationOtherDetails) {
  console.log(taxClassificationOtherDetailsElem.value);
}

W9 Revision Date

📄w9RevisionDate (StringField): The Revision month and year of the W9 form.

for (const w9RevisionDateElem of result.document.w9RevisionDate) {
  console.log(w9RevisionDateElem.value);
}

Questions?

Join our Slack