Parse MRZ (Machine Readable Zone) from identity documents
npm install @vorld/mrz[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![David deps][david-image]][david-url]
[![npm download][download-image]][download-url]
Parse MRZ (Machine Readable Zone) from identity documents.
$ npm install --save mrz
``js
const parse = require('mrz').parse;
let mrz = [
'I
'ERIKSSON<
var result = parse(mrz);
console.log(result);
`
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 andresult.details
details about the invalid fields can be found in .
#### 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
* FRENCH_DRIVING_LICENSE
* ESTONIAN_DRIVING_LICENSE
* IRELAND_DRIVING_LICENSE
#### 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 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.null
* value {string} - Value of the field or .line
* valid {boolean}
* ranges {Array} - Array of ranges that are necessary to compute this field.
Ranges are objects with , start, end and raw.line
* 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
Static mapping of supported formats.
Static mapping of state code to state name.
https://www.icao.int/publications/pages/publication.aspx?docnum=9303
http://www.astra2.admin.ch/media/pdfpub/2003-10-15_2262_f.pdf
https://fr.wikipedia.org/wiki/Carte_nationale_d%27identit%C3%A9_en_France#Codage_Bande_MRZ_(lecture_optique)
[npm-image]: https://img.shields.io/npm/v/mrz.svg?style=flat-square
[npm-url]: https://npmjs.org/package/mrz
[travis-image]: https://img.shields.io/travis/cheminfo-js/mrz/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/cheminfo-js/mrz
[coveralls-image]: https://img.shields.io/coveralls/cheminfo-js/mrz.svg?style=flat-square
[coveralls-url]: https://coveralls.io/github/cheminfo-js/mrz
[david-image]: https://img.shields.io/david/cheminfo-js/mrz.svg?style=flat-square
[david-url]: https://david-dm.org/cheminfo-js/mrz
[download-image]: https://img.shields.io/npm/dm/mrz.svg?style=flat-square
[download-url]: https://npmjs.org/package/mrz