Hi, I have checker = TD3CodeChecker(line1 line2) and it returns True
but when I check checker == True it returns False. Do you know why and how can I resolve this?

Also, the first example MRZ, is an instance of another false-positive, where optional data hash fails when optional-data is empty (all <) and optional-data-hash is < (instead of 0). I think it may be an error according to specs, but exists in real-world.

Originally posted by @tahajahangir in #1 (comment)

Name comes blank even if there and surname is not present.

I discovered that something similar (comes from #1) happens in mrz.generator. When the primary identifier is not given, an incorrect output is got. For example:

from mrz.generator.td3 import TD3CodeGenerator

print(TD3CodeGenerator("P",           # Document type
                       "Utopia",      # Country
                       "",            # Surname(s)
                       "Anna María",  # Given name(s)
                       "L898902C3",   # Passport number
                       "UTO",         # Nationality
                       "740812",      # Birth date
                       "F",           # Genre
                       "120415",      # Expiry date
                       "ZE184226B"))  # Id number

This wrong output is got:

P<UTO<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<<<<<<<<<
L898902C36UTO7408122F1204159ZE184226B<<<<<10

Originally posted by @Arg0s1080 in #1 (comment)

Thanks for great repo.
I read from tutorial, maybe I miss information for generate to image
I see issue can create basic information passport,
But i want to check by see the info in image
My question is: " how to generate passport with my background and save it to image?"
Many thanks

Some passports (TD3 MRZ) have only one name, like:

P<IND<<AHMADI<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
K2578285<7IND5601240F2202288<<<<<<<<<<<<<<<4

or

P<PAKZAHRA<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
DD51243520PAK8501019F27032135440067474356<98

TD3CodeChecker(value) for this input fails with this exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "lib/python3.7/site-packages/mrz/checker/td3.py", line 123, in __init__
    self.result = self._all_hashes() & self._all_fields()
  File "lib/python3.7/site-packages/mrz/checker/_fields.py", line 223, in _all_fields
    self.optional_data &
  File "lib/python3.7/site-packages/mrz/checker/_fields.py", line 92, in identifier
    if check.begin_by(primary, "<") or check.begin_by(secondary, "<"):
  File "lib/python3.7/site-packages/mrz/base/string_checkers.py", line 119, in begin_by
    if string[0] != char:
IndexError: string index out of range

Hello I have a code block like this:

...
checker1 = TD3CodeChecker(...)

if bool(checker1) == True:
    ...
else:
   ...

The problem is when checker1 does not return True then all the lines below it won't run (the else statement never triggered).

lib incorrect calc hash value.

from mrz.generator.td1 import TD1CodeGenerator,dictionary

x1 = 'ID'
x2 = 'GEO'
x3 = '13IN30572'
x4 = '910526'
x5 = 'M'
x6 = '251221'
x7 = 'GEO'
x8 = 'MAMEDOV'
x9 = 'IUKSEL'
x10 ='10011051644'
dictionary.c
text = TD1CodeGenerator(x1,x2,x3,x4,x5,x6,x7,x8,x9,x10,force=False)
print(text)        

Hi there, thank you for making this library!

I have an issue with TD1, specifically scanning Belgian ID cards. If the document_number_hash digit is "<" the document will not verify.

I have checked this with 3 different Belgian ID cards and they all have "<" on index 14 of line 0.

After a ton of googling and reading specs I found an issue with the way you check document_number_hash...

Normally a document number starts at position 5 and ends at position 13 but sometimes a document number exceeds the size of it's slot and optional fields will be used, let's take a look at this example:

IDBEL123456789<1233<<<<<<<<<<<

In this case the document number check is < when we have a scenario like that we need to look at the optional numbers (1233). So when the document number check is < we need to look at the last none empty value: 3. This is the actual hash number. After that we simply verify the hash of:

Document Number: 123456789<123
Hash: 3

And this should verify as True using your verify function.

from string import ascii_uppercase, digits

def hash_string(string: str) -> str:
    """
    >>> hash_string("ABCDEFGHIJKLMNOPQRSTUVWXYZ")
    '7'
    >>> hash_string("0123456789")
    '7'
    >>> hash_string("0123456789ABCDEF")
    '0'
    >>> hash_string("0")
    '0'
    """
    printable = digits + ascii_uppercase
    string = string.upper().replace("<", "0")
    weight = [7, 3, 1]
    summation = 0
    for i in range(len(string)):
        c = string[i]
        if c not in printable:
            raise ValueError("%s contains invalid characters" % string, c)
        summation += printable.index(c) * weight[i % 3]
    return str(summation % 10)

print(hash_string("123456789<123"))

Hi, the mrz checker module works great! However, I would like to pip install the latest version of mrz which includes the fields() function. How do I do so?

There maybe a bug somewhere when I tried this with my real passport info several times. The checker returns false all the time, the report_falses return [('identifier', False)]. However I still can print out all the fields and they're all correct

The country code listed for Interpol in base/countries.py seems to be wrong.

According to the specs it should be XPO, not INP
(see page 22 in ICAO Doc 9303 part 3)

As XPO is already listed, INP could be removed.
It is neither an ISO country code, nor part of the additional codes listed in the specs.

I'm not really sure this functionality belongs here, but as the knowledge of the MRZ internal structure is only present in this module, why not... let me know what you think!

I work with scanned MRZ, and as comes with the process, the OCR sometimes mis-reads similar characters. For example, I have seen countries read as "R0U" or a name "SZ0BO5ZLAI". And the MRZ checker correctly warns that the nationality or the identifier is not valid. However, if you could add a method repair() to the checkers

def __init__(self, mrz_code: str, check_expiry=False, compute_warnings=False, precheck=True):
        precheck and check.precheck("TD1", mrz_code, 92)
        lines = mrz_code.splitlines()
        self._document_type = self.repair('document type', lines[0][0: 2])
        self._country = self.repair('country', lines[0][2: 5])
        [...]

def repair(self, field_name: str, field_content: str):
        return field_content

that would allow me to do things like:

class MyChecker(TD1CodeChecker):
    def repair(self, name, content):
        if name in ('country', 'identifier', ...):
            # I know those can only contain alphas
            return self.replace_often_mistaken_numbers_by_alphas(content)

        if name in ('expiry date', 'birth date'):
            return self.replace_often_mistaken_alphas_by_numbers(content)

    def replace_often_mistaken_numbers_by_alphas(self, s):
        return s.replace('5', 'S').replace('1', 'I').replace('0', 'O')

This would make the checker more useful when presented with badly scanned data.

The alternative would be that I somehow preprocess the MRZ, but then I would have to re-implement the MRZ structure definition in my code too. As said above, I'm not a big fan of shoehorning that functionality into this module, but I don't see any other place that has enough knowledge of the MRZ structure.

Comes from #3

I think it would be a good idea to add the possibility of disabling checks for certain fields in future mrz.checker versions.

Hi,

I can't seem to get the installation to work on MacOs Catalina

This is the error message:

pip install mrz
Looking in indexes: https://pypi.org/simple, https://www.piwheels.org/simple
Collecting mrz
  Using cached https://files.pythonhosted.org/packages/85/8b/8568edf6c8725675504dcca8e4eac15ea8edb4c397f1e6d1e01d759955e9/mrz-0.6.2.tar.gz
    Complete output from command python setup.py egg_info:
    MRZ does not work on Python version < 3.4
    Your version is: 2.7.16
    
    ----------------------------------------
Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-install-BuVQ9w/mrz/

There's no code release on this repository. Releases help developers get the source code of specific versions, usually when trying to look at the source code of a version from Pypi.
If possible, please match the releases here with the releases of the Pypi package.

Hello

mrz image.jpg > image.txt

takes about 8 - 10 seconds the 1st time for an image when that image is processed for the 1st time. The 2nd time it is a lot more faster

How do I make it faster the 1st time? Should i keep any training data locally , or any other tips please?

This is on windows 64 BIT with at least 10 GB virtual memory

Many Thanks

Estonian ID Cards seem to (sometimes? I've only had one in my data set so far!) set the document number checksum to "<", which seems to indicate no checksum.

I have not found anything in the standards for using the "<" in checksums though. Is this something you have seen before?

Hi, thanks for the amazing work.

Can I use this to generate unlimited random MRZ ?

Right now I'm very busy and have very little free time. Please, before creating an issue or consulting by email, follow the following steps:

For example, If i have the following sample and i want to generate MRZ Code with MRZ Generator:

• Check that MRZ is installed (Yes, sometimes it happens xD!)

• See distribution fields image:

• Search examples folder for a similar case:
  • [Mmmhm... this could be used!]

#!/usr/bin/python3
# -*- coding: UTF-8 -*-

from mrz.generator.td1 import *
from examples.functions.functions import open_image


print(TD1CodeGenerator(
            "ID",                                 # Document type   Normally 'I' or 'ID' for id cards
            "Serbia",                             # Country         3 letters code or country name
            "955555546",                          # Document number Special characters will be transliterated
            "680229",                             # Birth date      YYMMDD
            "F",                                  # Genre           Male: 'M', Female: 'F' or Undefined 'X'
            "130724",                             # Expiry date     YYMMDD
            "Serbia",                             # Nationality
            "ТЕСТ",                               # Surname         Special characters will be transliterated
            "МИЛИЦА",                             # Given name(s)   Special characters will be transliterated
            "2902968000000",                      # Optional data 1 empty string by default
            "",                                   # Optional data 2 empty string by default
            dictionary.cyrillic_serbian()))       # Transliteration Dictionary (latin by default)
open_image("id_cards", "Serbia.png")

• Modify the example and run it:

from mrz.generator.td1 import TD1CodeGenerator

print(TD1CodeGenerator("CA",                 # Document type   Normally 'I' or 'ID' for id cards
                       "CAN",                # Country         3 letters code or country name
                       "9B0002562",          # Document number
                       "750625",             # Birth date      YYMMDD
                       "F",                  # Genre           Male: 'M', Female: 'F' or Undefined
                       "201029",             # Expiry date     YYMMDD
                       "MOZ",                # Nationality
                       "SPECIMEN SUMBI",     # Surname         Special characters will be transliterated
                       "GEESHNIKUT",         # Given name(s)   Special characters will be transliterated
                       "<00185978<<<<<5",    # Optional data 1
                       "<151106<01",         # Optional data 2
                       ))   # It's not necessary to transliterate .. I can ignore it

• Lets get the output:
  • If the output is correct: No problem. FINISH
  • If the output is incorrect:
    • I check all the steps again:
      • If output is correct: Nothing happens.. I had a typo or something like that. No problem. FINISH
      • If the output is not correct: Oops! There is probably a bug or a special case. Then preferably create an issue or alternatively ask by email
  • If the output is correct but i would like it to work differentely
    • Think if it only affects my own needs or everyone's needs (or that of many)
      • If it only affects me: Modify the code or write a class that overrides originals. Tip: See what's done in special cases folder (Note: Due a desing problem the name of the class must start with TD1, TD2, TD3 or Passport and must end with CodeGenerator or CodeChecker)
      • If it benefits to everyone (or many): Open a new issue requesting a enhancement or make a Pull Request

I understand that errors happen (I make a lot everyday), but please... I demand a minimum of effort before asking.

Thank you very much and best regards

When running on Linux Manjaro, I get the error:

File "/home/user/mrz/examples/mrz_generator_samples/passport_uto.py", line 5, in
from examples.functions.functions import open_image
ModuleNotFoundError: No module named 'examples.functions'

Run command: python passport_uto.py
How i can fix this error?

Several people have asked me by email how they get the fields (names, surnames, nationality, type of document, etc. strings) without access to a protected member of the class. Therefore I have created the fields() method for td1, td2, td3, mrva and mrvb.

For example:

from mrz.checker.td1 import TD1CodeChecker, get_country

mrz_td1 = ("IDD<<ID98754015<<<<<<<<<<<<<<<\n" 
           "8205122M1906224D<<<<<<<<<<<<<6\n" 
           "SCHNEIDER<WEBER<<NORBERT<<<<<<")

td1_check = TD1CodeChecker(mrz_td1)

To get identifiers, country, and date of birth....

Before (accessing to protected members of the class):

print(td1_check._identifier)
print(td1_check._country)
print(td1_check._birth_date)

Output:

SCHNEIDER<WEBER<<NORBERT<<<<<<
D<<
820512

Now:

fields() method returns a namedtuple with all fields strings:

td1_check.fields()

Returns:

fields(document_type='ID', country='D', document_number='ID9875401', document_number_hash='5', optional_data='', birth_date='820512', birth_date_hash='2', sex='M', expiry_date='190622', expiry_date_hash='4', nationality='D', optional_data_2='', final_hash='6', surname='SCHNEIDER WEBER', name='NORBERT')

So, to get given names, surnames and birth date:

fields = td1_check.fields()
print(fields.surname)
print(fields.name)
print(get_country(fields.country))
print(fields.birth_date)

Output:

SCHNEIDER WEBER
NORBERT
Germany
820512

Available fields

id cards and others td1's:

surname, name, country, nationality, birth_date, expiry_date, sex, document_type,
document_number, optional_data, birth_date_hash, expiry_date_hash, document_number_hash,
 optional_data_2 and final_hash

td2's:

surname, name, country, nationality, birth_date, expiry_date, sex, document_type,
document_number, optional_data, birth_date_hash, expiry_date_hash, document_number_hash
and final_hash

Passports and other td3's:

surname, name, country, nationality, birth_date, expiry_date, sex, document_type,
document_number, optional_data, birth_date_hash, expiry_date_hash, document_number_hash,
optional_data_hash and final_hash

Any Visa (mrva & mrvb)

surname, name, country, nationality, birth_date, expiry_date, sex, document_type,
document_number, optional_data, birth_date_hash, expiry_date_hash and document_number_hash

Hi!

I have a Swiss passport with a MRZ in the TD3 format. On this document no optional data is used, hence its MRZ value is <<<<<<<<<<<<<<. The corresponding optional data hash is <.

I would expect that this would result in a valid MRZ readout, but this seems not the case. The empty values are not recognized as a valid value-hash pair: hash_is_ok("<<<<<<<<<<<<<<", "<") returns False. This in turn causes TD3CodeChecker(mrz) to cast to a False boolean.

The netherlands ID (TD1) has optional data. at line 1 position 30 there is a hash number. Is there any chance for me to change the script of TD1 for another hash at line 1 pos 30?

I believe, there is an error in TD1CodeChecker, atlest for some IDs.

Two letter country codes and nationality codes do not pass the check, while three letter country codes do.

There should also be a possibility of two letter country codes added to check, because some IDs have two letter country and nationality code.

Is there any tutorial how to use this? Im new at this and don’t know what to do. I already have python and used pip install MRZ but I don’t know what else to do. I need to generate german id mrz

I have not tried your application yet, but I have investigated the isse for some time, and if you use the documents you refer to as te background for generatoing MRZ code ("Specifications for Machine Readable Passports (MRPs)"), then it does not seem to take into account that there can be more than 2 digits a the end of line 2.

Every US passports I have seen lately look something like this in line 2: ".......123456789<23456" and not like "....123456789<<<32"
I have not been able to find any documentation for this?

Have you solved this issue?

/Christian

In the list of countries (mrz/base/countries), all countries are denoted with 3 letters except Germany which is denoted with the single letter D while acording to: ISO_3166-1 it should be DEU

Hello,

I ran into the following bug when calling the precheck method:

raise LengthError(cause=len(s), document=document_description, length=length)
NameError: name 's' is not defined

Having a look at precheck method in string_checkers.py in 0.5.8 I observe the following:

def precheck(document_description: str, string: str, length: int):
    s = string.replace("\n", "")
    if _is_string(_check_upper(string)) and len(s) != length:
        raise LengthError(cause=len(s), document=document_description, length=length)
    if not is_printable(s):
        raise FieldError("%s contains invalid characters" % document_description, s)

Having a look at precheck method in string_checkers.py in 0.6.1 I observe the following:

def precheck(document_description: str, string: str, length: int):
    if check_string(_check_upper(string)) and len(string) != length:
        raise LengthError(cause=len(s), document=document_description, length=length)
    if not is_printable(string, "\n"):
        raise FieldError("%s contains invalid characters" % document_description, s)

Since the removal of s = string.replace("\n", "") there is no defined variable s anymore. Both the LengthError and FieldError reference to this. I believe it should be string instead of s now.

According to page 14 of this ICAO document: https://www.icao.int/publications/Documents/9303_p5_cons_en.pdf

Sex in the MRZ can be: M for male,F for female, and < for nonspecified.
However, the generator puts in a X for nonspecified instead of a <.

This is correct for the VIZ as can be seen in the same document at page 11.
But not for the MRZ.

The document refers to TD1 but it also aplies for the other document types:

• TD3: https://www.icao.int/publications/Documents/9303_p4_cons_en.pdf
• TD2: https://www.icao.int/publications/Documents/9303_p6_cons_en.pdf
• VISA: https://www.icao.int/publications/Documents/9303_p7_cons_en.pdf

mrz.generator.mrva contains MRVBCodeGenerator instead of MRVACodeGenerator.
I think this is a copy-paste error.

While working with austrian ID cards and passports, I noticed that many of them fail the "optional data hash" check. For example (name and ID number redacted):

P<AUTPL***<<**********<<<<<<<<<<<<<<<<<<<<<<
U******9<4AUT9211041F2505060<<<<<<<<<<<<<<<2
type TD3

--> False 
fields(surname='PL***', name='*********', country='AUT', nationality='AUT', birth_date='921104', 
expiry_date='250506', sex='F', document_type='P', document_number='U******9', optional_data='', 
birth_date_hash='1', expiry_date_hash='0', document_number_hash='4', optional_data_hash='<', 
final_hash='2')

[('final hash', True), ('document number hash', True), ('birth date hash', True), ('expiry date hash', True),
('optional data hash', False), ('document type format', True), ('valid country code', True), 
('valid nationality code', True), ('birth date', True), ('expiry date', True), ('valid genre format', True), 
('identifier', True), ('document number format', True)]

and

P<AUTK******<<*********<<<<<<<<<<<<<<<<<<<<<
U******3<0AUT8402183M2610209<<<<<<<<<<<<<<<0
type TD3

--> False 
fields(surname='K******', name='*********', country='AUT', nationality='AUT', birth_date='840218',
expiry_date='261020', sex='M', document_type='P', document_number='U******3', optional_data='',
birth_date_hash='3', expiry_date_hash='9', document_number_hash='0', optional_data_hash='<', 
final_hash='0')

[('final hash', True), ('document number hash', True), ('birth date hash', True), ('expiry date hash', True),
('optional data hash', False), ('document type format', True), ('valid country code', True), 
('valid nationality code', True), ('birth date', True), ('expiry date', True), ('valid genre format', True), 
('identifier', True), ('document number format', True)]

I suppose, that should not be checked if there is no optional_data and/or if the optional_data_hash is '<'?