BlinkID C SDK version 5.16.0
Data Fields
MBMRZResult Struct Reference

Result from reading Machine Readable Zone text from ID. More...

#include <MRZResult.h>

Data Fields

char const * rawMRZString
 
char const * documentCode
 
char const * issuer
 
char const * documentNumber
 
char const * opt1
 
char const * opt2
 
char const * gender
 
char const * nationality
 
char const * primaryID
 
char const * secondaryID
 
char const * alienNumber
 
char const * applicationReceiptNumber
 
char const * immigrantCaseNumber
 
char const * issuerName
 
char const * nationalityName
 
MBBool verified
 
MBBool parsed
 
MBDate dateOfBirth
 
MBDate dateOfExpiry
 
MBMRTDDocumentType documentType
 

Detailed Description

Result from reading Machine Readable Zone text from ID.

Field Documentation

◆ alienNumber

char const* MBMRZResult::alienNumber

The alien number. Contains empty string if not available. Exists only on US Green Cards. To see which document was scanned use documentType.

◆ applicationReceiptNumber

char const* MBMRZResult::applicationReceiptNumber

The application receipt number. Contains empty string if not available. Exists only on US Green Cards. To see which document was scanned use documentType.

◆ dateOfBirth

MBDate MBMRZResult::dateOfBirth

The holder's date of birth

◆ dateOfExpiry

MBDate MBMRZResult::dateOfExpiry

The date of expiry

◆ documentCode

char const* MBMRZResult::documentCode

The document code. Document code contains two characters. For MRTD the first character shall be A, C or I. The second character shall be discretion of the issuing State or organization except that V shall not be used, and C shall not be used after A except in the crew member certificate. On machine-readable passports (MRP) first character shall be P to designate an MRP. One additional letter may be used, at the discretion of the issuing State or organization, to designate a particular MRP. If the second character position is not used for this purpose, it shall be filled by the filter character <.

◆ documentNumber

char const* MBMRZResult::documentNumber

The document number. Document number contains up to 9 characters. Element does not exist on US Green Card. To see which document was scanned use documentType.

◆ documentType

MBMRTDDocumentType MBMRZResult::documentType

The MRTD document type of recognized document.

◆ gender

char const* MBMRZResult::gender

The gender of the card holder. Gender is specified by use of the single initial, capital letter F for female, M for male or < for unspecified.

◆ immigrantCaseNumber

char const* MBMRZResult::immigrantCaseNumber

The immigrant case number. Contains empty string if not available. Exists only on US Green Cards. To see which document was scanned use documentType.

◆ issuer

char const* MBMRZResult::issuer

The three-letter or two-letter code which indicate the issuing State. Three-letter codes are based on Aplha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.

◆ issuerName

char const* MBMRZResult::issuerName

The full issuer name that is expanded from the three-letter or two-letter code which indicate the issuing State.

◆ nationality

char const* MBMRZResult::nationality

Returns nationality of the holder represented by a three-letter or two-letter code. Three-letter codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.

◆ nationalityName

char const* MBMRZResult::nationalityName

Full nationality of the holder, which is expanded from the three-letter or two-letter nationality code.

◆ opt1

char const* MBMRZResult::opt1

The first optional data. Contains empty string if not available. Element does not exist on US Green Card. To see which document was scanned use documentType.

◆ opt2

char const* MBMRZResult::opt2

The second optional data. Contains empty string if not available. Element does not exist on Passports and Visas. To see which document was scanned use documentType.

◆ parsed

MBBool MBMRZResult::parsed

true if Machine Readable Zone has been parsed, false otherwise.

◆ primaryID

char const* MBMRZResult::primaryID

The primary indentifier. If there is more than one component, they are separated with space.

◆ rawMRZString

char const* MBMRZResult::rawMRZString

The entire Machine Readable Zone text from ID. This text is usually used for parsing other elements. NOTE: This string is available only if OCR result was parsed successfully.

◆ secondaryID

char const* MBMRZResult::secondaryID

The secondary identifier. If there is more than one component, they are separated with space.

◆ verified

MBBool MBMRZResult::verified

True if all check digits inside MRZ are correct, false otherwise.


The documentation for this struct was generated from the following file: