.. index:: 
  !MrzHelper Class

.. _id3_document_mrz_helper_class:

===============================================================================
MrzHelper Class
===============================================================================

Namespace: :ref:`id3.Document<reference_document>`

.. toctree::
  :hidden:

  check<check>
  decode<decode>


Definition
----------
.. line-block::
    Provides functionalities to decode and check a MRZ.

.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        class MrzHelper

    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        class MrzHelper

    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public static partial class MrzHelper

    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public class MrzHelper

    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public class MrzHelper


Static Methods
--------------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`check<id3_document_mrz_helper_check_class_method>`
    - Checks the validity of a single line of an MRZ of a given type by checking the check digits.
  * - :ref:`decode<id3_document_mrz_helper_decode_class_method>`
    - Decodes an MRZ of a given type and returns the values of the various fields.
