Documentation
Log inGet started

US Driver License OCR Node.js

Suggest Edits

The Node.js OCR SDK supports the Driver License API.

Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
Driver License 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.DriverLicenseV1,
  inputSource
);

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

Output (RST):

########
Document
########
:Mindee ID: bf70068d-d3d6-49dc-b93a-b4b7d156fc3d
:Filename: default_sample.jpg

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

Prediction
==========
:State: AZ
:Driver License ID: D12345678
:Expiry Date: 2018-02-01
:Date Of Issue: 2013-01-10
:Last Name: SAMPLE
:First Name: JELANI
:Address: 123 MAIN STREET PHOENIX AZ 85007
:Date Of Birth: 1957-02-01
:Restrictions: NONE
:Endorsements: NONE
:Driver License Class: D
:Sex: M
:Height: 5-08
:Weight: 185
:Hair Color: BRO
:Eye Color: BRO
:Document Discriminator: 1234567890123456

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

Page 0
------
:Photo: Polygon with 4 points.
:Signature: Polygon with 4 points.
:State: AZ
:Driver License ID: D12345678
:Expiry Date: 2018-02-01
:Date Of Issue: 2013-01-10
:Last Name: SAMPLE
:First Name: JELANI
:Address: 123 MAIN STREET PHOENIX AZ 85007
:Date Of Birth: 1957-02-01
:Restrictions: NONE
:Endorsements: NONE
:Driver License Class: D
:Sex: M
:Height: 5-08
:Weight: 185
:Hair Color: BRO
:Eye Color: BRO
:Document Discriminator: 1234567890123456

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, always 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.

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 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 at document level.

Attributes

The following fields are extracted for Driver License V1:

Address

address (StringField): US driver license holders address

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

Date Of Birth

dateOfBirth (DateField): US driver license holders date of birth

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

Document Discriminator

ddNumber (StringField): Document Discriminator Number of the US Driver License

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

Driver License Class

dlClass (StringField): US driver license holders class

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

Driver License ID

driverLicenseId (StringField): ID number of the US Driver License.

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

Endorsements

endorsements (StringField): US driver license holders endorsements

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

Expiry Date

expiryDate (DateField): Date on which the documents expires.

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

Eye Color

eyeColor (StringField): US driver license holders eye colour

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

First Name

firstName (StringField): US driver license holders first name(s)

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

Hair Color

hairColor (StringField): US driver license holders hair colour

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

Height

height (StringField): US driver license holders hight

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

Date Of Issue

issuedDate (DateField): Date on which the documents was issued.

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

Last Name

lastName (StringField): US driver license holders last name

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

Photo

📄photo (PositionField): Has a photo of the US driver license holder

for (const photoElem of result.document.photo) {
  console.log(photoElem.polygon);
}

Restrictions

restrictions (StringField): US driver license holders restrictions

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

Sex

sex (StringField): US driver license holders gender

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

Signature

📄signature (PositionField): Has a signature of the US driver license holder

for (const signatureElem of result.document.signature) {
  console.log(signatureElem.polygon);
}

State

state (StringField): US State

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

Weight

weight (StringField): US driver license holders weight

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

Questions?

Join our Slack

Updated 2 months ago