README

mrz

Parse MRZ (Machine Readable Zone) from identity documents.

Maintained by Zakodium

Installation

$ npm install mrz

Example

const parse = require('mrz').parse;

let mrz = [
  'I<UTOD23145890<1233<<<<<<<<<<<',
  '7408122F1204159UTO<<<<<<<<<<<6',
  'ERIKSSON<<ANNA<MARIA<<<<<<<<<<',
];

var result = parse(mrz);
console.log(result);

API

parse(mrz)

Parses the provided MRZ. The argument can be an array of lines or a single string including line breaks. This function throws an error if the input is in an unsupported format. It will never throw an error when there are invalid fields in the MRZ. Instead, the result.valid value will be false and details about the invalid fields can be found in result.details.

result.format

String identifying the format of the parsed MRZ. Supported formats are:

TD1 (identity card with three MRZ lines)
TD2 (identity card with two MRZ lines)
TD3 (passport)
SWISS_DRIVING_LICENSE
FRENCH_NATIONAL_ID

result.valid

true if all fields are valid. false otherwise.

result.fields

Object mapping field names to their respective value. The value is set to null if it is invalid. The value may be different than the raw value. For example result.fields.sex will be "male" when the raw value was "M".

result.details

Array of objects describing all parsed fields. Its structure is:

label {string} - Full english term for the field.
field {string} - Name of the field in result.fields.
value {string} - Value of the field or null.
valid {boolean}
ranges {Array} - Array of ranges that are necessary to compute this field. Ranges are objects with line, start, end and raw.
line {number} - Index of the line where the field is located.
start {number} - Index of the start of the field in line.
end {number} - Index of the end of the field in line.

formats

Static mapping of supported formats.

states

Static mapping of state code to state name.

Specifications

License

MIT

Usage no npm install needed!