Passport OCR Java
The JAVA OCR SDK supports the passport API for extracting data from passports.
Using this sample passport below,
we are going to illustrate how to extract the data that we want using the OCR SDK.
Quick Start
public class SimpleMindeeClient {
public static void main(String[] args) throws IOException {
// Init a new client
MindeeClient client = new MindeeClient("my-api-key");
// Load a file from disk and parse it
LocalInputSource localInputSource = new LocalInputSource(
new File("./4a16b1d-passport_pic.jpg")
);
PredictResponse<PassportV1> document = mindeeClient.parse(
PassportV1.class, localInputSource
);
// Print a summary of the parsed data
logger.info(document.toString());
}
}
Output:
########
Document
########
:Mindee ID: 79db59c7-b312-4692-a77f-e8698666ffba
:Filename: passport.jpeg
Inference
#########
:Product: mindee/passport v1.0
:Rotation applied: No
Prediction
==========
:Full name: HENERT PUDARSAN
:Given names: HENERT
:Surname: PUDARSAN
:Country: GBR
:ID Number: 707797979
:Issuance date: 2012-04-22
:Birth date: 1995-05-20
:Expiry date: 2057-04-22
:MRZ 1: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<
:MRZ 2: 7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
:MRZ: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
Page Predictions
================
Page 0
------
:Full name: HENERT PUDARSAN
:Given names: HENERT
:Surname: PUDARSAN
:Country: GBR
:ID Number: 707797979
:Issuance date: 2012-04-22
:Birth date: 1995-05-20
:Expiry date: 2057-04-22
:MRZ 1: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<
:MRZ 2: 7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
:MRZ: P<GBRPUDARSAN<<HENERT<<<<<<<<<<<<<<<<<<<<<<<7077979792GBR9505209M1704224<<<<<<<<<<<<<<00
Field Objects
Each Field
object contains at a minimum the following attributes:
value
(string or number depending on the field type):
Corresponds to the field value. Can benull
if no value was extracted.confidence
(Double):
The confidence score of the field prediction.polygon
(Polygon):
Contains exactly 4 relative vertices coordinates (points) of a right rectangle containing the field in the document.
Extracted Fields
Depending on the field type specified, additional attributes can be extracted from the Passport
object.
Using the above passport example, the following are the basic fields that can be extracted.
- Birth Place
- Country
- Dates (Expiry, Issuance, Birth)
- Gender
- Given Names
- ID Number
- Machine Readable Zone
- Surname
Birth Place
birthPlace
(Field): Passport owner birthplace.
Country
country
(Field): Passport country in ISO 3166-1 alpha-3 code format (3 letters code).
Dates
Date fields:
- have a
value
attribute which is the ISO 8601 representation of the date, regardless of theraw
contents.
The following date fields are available:
-
expiryDate
: Passport expiry date. -
issuanceDate
: Passport date of issuance. -
birthDate
: Passport's owner date of birth.
Gender
gender
(StringField): Passport owner's gender (M / F).
Given Names
givenNames
(List): List of passport owner's given names.
ID
idNumber
(StringField): Passport identification number.
Machine Readable Zone
-
mrz1
(StringField): Passport first line of machine-readable zone. -
mrz2
(StringField): Passport second line of machine-readable zone.
Surname
surname
(StringField): Passport's owner surname.
Questions?
Updated 27 days ago