Description:

See all 9303 ICAO docs (البيت العربي,中文,English,Français,Русский andEspañol)

Fields Distribution of Official Travel Documents:

Usage Generator:

TD1's (id cards):

Params:                      Case insensitive    document_type    (str):  The first letter shall be 'I', 'A' or 'C'    country_code     (str):  3 letters code (ISO 3166-1) or country name (in English)    document_number  (str):  Document number    birth_date       (str):  YYMMDD    sex              (str):  Genre. Male: 'M', Female: 'F' or Undefined: 'X', "<" or ""    expiry_date      (str):  YYMMDD    nationality      (str):  3 letters code (ISO 3166-1) or country name (in English)    surname          (str):  Holder primary identifier(s). This field will be transliterated    given_names      (str):  Holder secondary identifier(s). This field will be transliterated    optional_data1   (str):  Optional personal data at the discretion of the issuing State.                             Non-mandatory field. Empty string by default    optional_data2   (str):  Optional personal data at the discretion of the issuing State.                             Non-mandatory field. Empty string by default    transliteration (dict):  Transliteration dictionary for non-ascii chars. Latin based by default    force           (bool):  Disables checks for country, nationality and document_type fields.                             Allows to use 3-letter-codes not included in the countries dictionary                             and to use document_type codes without restrictions.

TD2

Params:                      Case insensitive    document_type    (str):  The first letter shall be 'I', 'A' or 'C'    country_code     (str):  3 letters code (ISO 3166-1) or country name (in English)    surname          (str):  Holder primary identifier(s). This field will be transliterated.    given_names      (str):  Holder secondary identifier(s). This field will be transliterated.    document_number  (str):  Document number.    nationality      (str):  3 letters code (ISO 3166-1) or country name    birth_date       (str):  YYMMDD    sex              (str):  Genre. Male: 'M', Female: 'F' or Undefined: 'X', "<" or ""    expiry_date      (str):  YYMMDD    optional_data    (str):  Optional personal data at the discretion of the issuing State.                             Non-mandatory field. Empty string by default    transliteration (dict):  Transliteration dictionary for non-ascii chars. Latin based by default    force           (bool):  Disables checks for country, nationality and document_type fields.                             Allows to use 3-letter-codes not included in the countries dictionary                             and to use document_type codes without restrictions.

TD3 (Passports)

Params:                      Case insensitive    document_type    (str):  Normally 'P' for passport    country_code     (str):  3 letters code (ISO 3166-1) or country name (in English)    surname          (str):  Primary identifier(s)    given_names      (str):  Secondary identifier(s)    document_number  (str):  Document number    nationality      (str):  3 letters code (ISO 3166-1) or country name    birth_date       (str):  YYMMDD    sex              (str):  Genre. Male: 'M', Female: 'F' or Undefined: 'X', "<" or ""    expiry_date      (str):  YYMMDD    optional data    (str):  Personal number. In some countries non-mandatory field. Empty string by default    transliteration (dict):  Transliteration dictionary for non-ascii chars. Latin based by default    force           (bool):  Disables checks for country, nationality and document_type fields.                             Allows to use 3-letter-codes not included in the countries dictionary                             and to use document_type codes without restrictions.

MRVA (Visas type A)

Params:                      Case insensitive    document_type    (str):  The First letter must be 'V'    country_code     (str):  3 letters code (ISO 3166-1) or country name (in English)    surname          (str):  Primary identifier(s)    given_names      (str):  Secondary identifier(s)    document_number  (str):  Document number    nationality      (str):  3 letters code (ISO 3166-1) or country name    birth_date       (str):  YYMMDD    sex              (str):  Genre. Male: 'M', Female: 'F' or Undefined: 'X', "<" or ""    expiry_date      (str):  YYMMDD    optional_data    (str):  Optional personal data at the discretion of the issuing State.                             Non-mandatory field. Empty string by default.    transliteration (dict):  Transliteration dictionary for non-ascii chars. Latin based by default    force           (bool):  Disables checks for country, nationality and document_type fields.                             Allows to use 3-letter-codes not included in the countries dictionary                             and to use document_type codes without restrictions.

MRVB (Visas type B)

Params:                      Case insensitive    document_type    (str):  The First letter must be 'V'    country_code     (str):  3 letters code (ISO 3166-1) or country name (in English)    surname          (str):  Primary identifier(s)    given_names      (str):  Secondary identifier(s)    document_number  (str):  Document number    nationality      (str):  3 letters code (ISO 3166-1) or country name    birth_date       (str):  YYMMDD    sex              (str):  Genre. Male: 'M', Female: 'F' or Undefined: 'X', "<" or ""    expiry_date      (str):  YYMMDD    optional_data    (str):  Optional personal data at the discretion of the issuing State.                             Non-mandatory field. Empty string by default.    transliteration (dict):  Transliteration dictionary for non-ascii chars. Latin based by default    force           (bool):  Disables checks for country, nationality and document_type fields.                             Allows to use 3-letter-codes not included in the countries dictionary                             and to use document_type codes without restrictions.

Passport generator example (ICAO9303 Specimen):

TD3CodeGenerator -> str:

frommrz.generator.td3importTD3CodeGeneratorcode=TD3CodeGenerator("P","UTO","Eriksson","Anna María","L898902C3","UTO","740812","F","120415","ZE184226B")print(code)

Output:

P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<L898902C36UTO7408122F1204159ZE184226B<<<<<10

Note: See other uses inmrz.generator examples folder

Usage Checker:

TD1's (id cards):

Params:    mrz_string        (str):  MRZ string of TD1. Must be 90 uppercase characters long (3 lines)    check_expiry     (bool):  If it's set to True, it is verified and reported as warning that the                              document is not expired and that expiry_date is not greater than 10 years    compute_warnings (bool):  If it's set True, warnings compute as False

TD2:

Params:    mrz_string        (str):  MRZ string of TD2. Must be 72 characters long (uppercase) (2 lines)    check_expiry     (bool):  If it's set to True, it is verified and reported as warning that the                              document is not expired and that expiry_date is not greater than 10 years    compute_warnings (bool):  If it's set True, warnings compute as False

TD3 (Passports):

Params:    mrz_string        (str):  MRZ string of TD3. Must be 88 characters long (uppercase) (2 lines)    check_expiry     (bool):  If it's set to True, it is verified and reported as warning that the                              document is not expired and that expiry_date is not greater than 10 years    compute_warnings (bool):  If it's set True, warnings compute as False

MRVA:

Params:    mrz_string        (str):  MRZ string of Visas type A. Must be 88 characters long (uppercase) (2 lines)    check_expiry     (bool):  If it's set to True, it is verified and reported as warning that the                              document is not expired and that expiry_date is not greater than 10 years    compute_warnings (bool):  If it's set True, warnings compute as False

MRVB:

Params:    mrz_string        (str):  MRZ string of Visas type B. Must be 72 characters long (uppercase) (2 lines)    check_expiry     (bool):  If it's set to True, it is verified and reported as warning that the                              document is not expired and that expiry_date is not greater than 10 years    compute_warnings (bool):  If it's set True, warnings compute as False

Id Card Checker example

TD1CodeChecker -> bool

frommrz.checker.td1importTD1CodeCheckercheck=TD1CodeChecker("I<SWE59000002<8198703142391<<<\n""8703145M1701027SWE<<<<<<<<<<<8\n""SPECIMEN<<SVEN<<<<<<<<<<<<<<<<")result=bool(check)print(result)

Output

True

Note: See other uses inmrz.checker examples folder

Fields extraction example (valid for td1, td2, td3 and visas)

frommrz.checker.td1importTD1CodeChecker,get_countrytd1_check=TD1CodeChecker("IDLIEID98754015<<<<<<<<<<<<<<<\n""8205122M1906224LIE<<<<<<<<<<<6\n""OSPELT<BECK<<MARISA<<<<<<<<<<<")fields=td1_check.fields()print(fields.name,fields.surname)print(get_country(fields.country))

Output

MARISA OSPELT BECKLiechtenstein

Note: See other uses inmrz.checker examples folder andthis issue

Installation:

FromPypi repo (It may not be the latest version):

pip install mrz

Cloning this repo (It may not work fine):

git clone https://github.com/Arg0s1080/mrz.gitcd mrzsudo python3 setup.py install

Features:

TODO:

IMPORTANT: