XML Schema for MRZ

XML schema for ABBYY FineReader Engine MRZ exports (MrzXmlSchema.xsd) — full MRZ text, extracted fields, and additional ID document information.

The data extracted from a machine-readable zone (MRZ) can be exported to an XML file. It contains the full text of the MRZ, the extracted fields and additional information. See the description of XML tags in the table below.

You can find the XML schema for MRZ in the MrzXmlSchema.xsd file. This file is located in the Headers folder for macOS or the Inc folder for Linux and Windows (Start > Programs > ABBYY FineReader Engine 12 > Installation Folders > Include Files Folder).

Description of XML Schema for MRZ

Name	Type	Multiplicity	Parent Tag	Description
MRZData	MRZDataType Type elements Field — the recognized MRZ field; has the FieldComplexType Line 1 — the first MRZ line; has the LineComplexType Line 2 — the second MRZ line; has the LineComplexType Line 3 — the third MRZ line, has the LineComplexType Has no type attributes	1	no	The recognized MRZ data.
Field	FieldComplexType Type elements Value — the field value (string) Checksum — the checksum of MRZ field; has the ChecksumComplexType Region — the field region; has the RegionComplexType Chars — attributes of the characters of the field; has the CharsComplexType Type attributes type — (string) field type. It can be one of the following values: BirthDate, DocumentNumber, DocumentSubType, DocumentType, GivenName, IssuingCountry, LastName, Nationality, PersonalNumber, Sex	0…unbounded	MRZData	The recognized MRZ field.
Line1 Line2	LineComplexType Type elements Value — the line value (string) Region — the field region; has the RegionComplexType Has no type attributes		MRZData	A line of MRZ.
Line3	LineComplexType	0…1	MRZData	The third line of MRZ.
Checksum	ChecksumComplexType Type elements Value — the checksum value (string) Verified — Result of MRZ field verification matches the recognized value. The valid values are TRUE and FALSE (string) Has no type attributes	0	Field	The checksum of MRZ field, available for some of the fields.
Region	RegionComplexType, the sequence of Rect tags Type elements Rect — rectangle of a block region. Rectangle is represented as a set of coordinates divided by commas (string) Has no type attributes	1	Field	The region of MRZ field.
Chars	CharsComplexType Type elements Char — single character; has the CharComplexType Has no type attributes	1	Field	Characters of the field.
Char	CharComplexType Type elements Value — the character value (string) Rect — rectangle of a block region. Rectangle is represented as a set of coordinates divided by commas (string) Type attributes Suspicious — the character was recognized uncertainly. The valid values are TRUE and FALSE (string)	0…unbounded	Chars	Attributes of a single character.

Tag hierarchy diagram

See also

IMrzData::ExportToFile

IMrzData::ExportToFileEx