Documentation
Log inGet started

US Driver License OCR Ruby

Suggest Edits

The Ruby 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

require 'mindee'

# Init a new client
mindee_client = Mindee::Client.new(api_key: 'my-api-key')

# Load a file from disk
input_source = mindee_client.source_from_path('/path/to/the/file.ext')

# Parse the file
result = mindee_client.parse(
  input_source,
  Mindee::Product::US::DriverLicense::DriverLicenseV1
)

# Print a full summary of the parsed data in RST format
puts result.document

# Print the document-level parsed data
# puts result.document.inference.prediction

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 (String, Float, Integer, Boolean): corresponds to the field value. Can be nil if no value was extracted.
  • confidence (Float, nil): the confidence score of the field prediction.
  • bounding_box (Mindee::Geometry::Quadrilateral, nil): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
  • polygon (Mindee::Geometry::Polygon, nil): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.
  • page_id (Integer, nil): the ID of the page, always nil when at document-level.
  • reconstructed (Boolean): indicates whether an object was reconstructed (not extracted as the API gave it).

Aside from the previous attributes, all basic fields have access to a to_s 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:

  • date_object (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 bounding_box, polygon and page_id. On top of these, it has access to:

  • rectangle (Mindee::Geometry::Quadrilateral): a Polygon with four points that may be oriented (even beyond canvas).
  • quadrangle (Mindee::Geometry::Quadrilateral): a free polygon made up of four points.

String Field

The text field StringField only has one constraint: it's value is a String (or nil).

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

puts result.document.inference.prediction.address.value

Date Of Birth

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

puts result.document.inference.prediction.date_of_birth.value

Document Discriminator

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

puts result.document.inference.prediction.dd_number.value

Driver License Class

dl_class (StringField): US driver license holders class

puts result.document.inference.prediction.dl_class.value

Driver License ID

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

puts result.document.inference.prediction.driver_license_id.value

Endorsements

endorsements (StringField): US driver license holders endorsements

puts result.document.inference.prediction.endorsements.value

Expiry Date

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

puts result.document.inference.prediction.expiry_date.value

Eye Color

eye_color (StringField): US driver license holders eye colour

puts result.document.inference.prediction.eye_color.value

First Name

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

puts result.document.inference.prediction.first_name.value

Hair Color

hair_color (StringField): US driver license holders hair colour

puts result.document.inference.prediction.hair_color.value

Height

height (StringField): US driver license holders hight

puts result.document.inference.prediction.height.value

Date Of Issue

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

puts result.document.inference.prediction.issued_date.value

Last Name

last_name (StringField): US driver license holders last name

puts result.document.inference.prediction.last_name.value

Photo

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

for photo_elem in result.document.photo do
  puts photo_elem.polygon
end

Restrictions

restrictions (StringField): US driver license holders restrictions

puts result.document.inference.prediction.restrictions.value

Sex

sex (StringField): US driver license holders gender

puts result.document.inference.prediction.sex.value

Signature

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

for signature_elem in result.document.signature do
  puts signature_elem.polygon
end

State

state (StringField): US State

puts result.document.inference.prediction.state.value

Weight

weight (StringField): US driver license holders weight

puts result.document.inference.prediction.weight.value

Questions?

Join our Slack

Updated 2 months ago