capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class MRZ

    MRZ part of the document

    Index

    Constructors

    constructor

    Properties

    BIRTH_DATE_FIELD_NAME BIRTH_DATE_FIELD_NAME_NORMALIZED CHECK_DIGIT_BIRTH_DATE_FIELD_NAME CHECK_DIGIT_BIRTH_DATE_FIELD_NAME_NORMALIZED CHECK_DIGIT_DOCUMENT_NUMBER_FIELD_NAME CHECK_DIGIT_DOCUMENT_NUMBER_FIELD_NAME_NORMALIZED CHECK_DIGIT_EXPIRY_DATE_FIELD_NAME CHECK_DIGIT_EXPIRY_DATE_FIELD_NAME_NORMALIZED CHECK_DIGIT_GENERAL_FIELD_NAME CHECK_DIGIT_GENERAL_FIELD_NAME_NORMALIZED CHECK_DIGIT_PERSONAL_NUMBER_FIELD_NAME CHECK_DIGIT_PERSONAL_NUMBER_FIELD_NAME_NORMALIZED DATE_OF_ISSUANCE_FIELD_NAME DATE_OF_ISSUANCE_FIELD_NAME_NORMALIZED DOCUMENT_NUMBER_FIELD_NAME DOCUMENT_NUMBER_FIELD_NAME_NORMALIZED DOCUMENT_TYPE DOCUMENT_TYPE_CODE_FIELD_NAME DOCUMENT_TYPE_CODE_FIELD_NAME_NORMALIZED DOCUMENT_TYPE_FIELD_NAME DOCUMENT_TYPE_FIELD_NAME_NORMALIZED EXPIRY_DATE_FIELD_NAME EXPIRY_DATE_FIELD_NAME_NORMALIZED GENDER_FIELD_NAME GENDER_FIELD_NAME_NORMALIZED GIVEN_NAMES_FIELD_NAME GIVEN_NAMES_FIELD_NAME_NORMALIZED ISSUING_AUTHORITY_FIELD_NAME ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED LANGUAGE_CODE_FIELD_NAME LANGUAGE_CODE_FIELD_NAME_NORMALIZED NATIONALITY_FIELD_NAME NATIONALITY_FIELD_NAME_NORMALIZED OFFICE_OF_ISSUANCE_FIELD_NAME OFFICE_OF_ISSUANCE_FIELD_NAME_NORMALIZED OPTIONAL_1_FIELD_NAME OPTIONAL_1_FIELD_NAME_NORMALIZED OPTIONAL_2_FIELD_NAME OPTIONAL_2_FIELD_NAME_NORMALIZED PERSONAL_NUMBER_FIELD_NAME PERSONAL_NUMBER_FIELD_NAME_NORMALIZED PIN_CODE_FIELD_NAME PIN_CODE_FIELD_NAME_NORMALIZED SURNAME_FIELD_NAME SURNAME_FIELD_NAME_NORMALIZED TRAVEL_DOC_TYPE_FIELD_NAME TRAVEL_DOC_TYPE_FIELD_NAME_NORMALIZED TRAVEL_DOC_TYPE_VARIANT_FIELD_NAME TRAVEL_DOC_TYPE_VARIANT_FIELD_NAME_NORMALIZED UNKNOWN_FIELD_NAME UNKNOWN_FIELD_NAME_NORMALIZED VERSION_NUMBER_FIELD_NAME VERSION_NUMBER_FIELD_NAME_NORMALIZED VISA_OPTIONAL_FIELD_NAME VISA_OPTIONAL_FIELD_NAME_NORMALIZED

    Accessors

    birthDate checkDigitBirthDate checkDigitDocumentNumber checkDigitExpiryDate checkDigitGeneral checkDigitPersonalNumber dateOfIssuance document documentNumber documentType documentTypeCode expiryDate gender givenNames issuingAuthority languageCode nationality officeOfIssuance optional1 optional2 personalNumber pinCode surname travelDocType travelDocTypeVariant unknown versionNumber visaOptional

    Methods

    requiredDocumentType

    Constructors

    Properties

    BIRTH_DATE_FIELD_NAME: "BirthDate"
    BIRTH_DATE_FIELD_NAME_NORMALIZED: "MRZ.BirthDate"
    CHECK_DIGIT_BIRTH_DATE_FIELD_NAME: "CheckDigitBirthDate"
    CHECK_DIGIT_BIRTH_DATE_FIELD_NAME_NORMALIZED: "MRZ.CheckDigitBirthDate"
    CHECK_DIGIT_DOCUMENT_NUMBER_FIELD_NAME: "CheckDigitDocumentNumber"
    CHECK_DIGIT_DOCUMENT_NUMBER_FIELD_NAME_NORMALIZED: "MRZ.CheckDigitDocumentNumber"
    CHECK_DIGIT_EXPIRY_DATE_FIELD_NAME: "CheckDigitExpiryDate"
    CHECK_DIGIT_EXPIRY_DATE_FIELD_NAME_NORMALIZED: "MRZ.CheckDigitExpiryDate"
    CHECK_DIGIT_GENERAL_FIELD_NAME: "CheckDigitGeneral"
    CHECK_DIGIT_GENERAL_FIELD_NAME_NORMALIZED: "MRZ.CheckDigitGeneral"
    CHECK_DIGIT_PERSONAL_NUMBER_FIELD_NAME: "CheckDigitPersonalNumber"
    CHECK_DIGIT_PERSONAL_NUMBER_FIELD_NAME_NORMALIZED: "MRZ.CheckDigitPersonalNumber"
    DATE_OF_ISSUANCE_FIELD_NAME: "DateOfIssuance"
    DATE_OF_ISSUANCE_FIELD_NAME_NORMALIZED: "MRZ.DateOfIssuance"
    DOCUMENT_NUMBER_FIELD_NAME: "DocumentNumber"
    DOCUMENT_NUMBER_FIELD_NAME_NORMALIZED: "MRZ.DocumentNumber"
    DOCUMENT_TYPE: "MRZ"
    DOCUMENT_TYPE_CODE_FIELD_NAME: "DocumentTypeCode"
    DOCUMENT_TYPE_CODE_FIELD_NAME_NORMALIZED: "MRZ.DocumentTypeCode"
    DOCUMENT_TYPE_FIELD_NAME: "DocumentType"
    DOCUMENT_TYPE_FIELD_NAME_NORMALIZED: "MRZ.DocumentType"
    EXPIRY_DATE_FIELD_NAME: "ExpiryDate"
    EXPIRY_DATE_FIELD_NAME_NORMALIZED: "MRZ.ExpiryDate"
    GENDER_FIELD_NAME: "Gender"
    GENDER_FIELD_NAME_NORMALIZED: "MRZ.Gender"
    GIVEN_NAMES_FIELD_NAME: "GivenNames"
    GIVEN_NAMES_FIELD_NAME_NORMALIZED: "MRZ.GivenNames"
    ISSUING_AUTHORITY_FIELD_NAME: "IssuingAuthority"
    ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED: "MRZ.IssuingAuthority"
    LANGUAGE_CODE_FIELD_NAME: "LanguageCode"
    LANGUAGE_CODE_FIELD_NAME_NORMALIZED: "MRZ.LanguageCode"
    NATIONALITY_FIELD_NAME: "Nationality"
    NATIONALITY_FIELD_NAME_NORMALIZED: "MRZ.Nationality"
    OFFICE_OF_ISSUANCE_FIELD_NAME: "OfficeOfIssuance"
    OFFICE_OF_ISSUANCE_FIELD_NAME_NORMALIZED: "MRZ.OfficeOfIssuance"
    OPTIONAL_1_FIELD_NAME: "Optional1"
    OPTIONAL_1_FIELD_NAME_NORMALIZED: "MRZ.Optional1"
    OPTIONAL_2_FIELD_NAME: "Optional2"
    OPTIONAL_2_FIELD_NAME_NORMALIZED: "MRZ.Optional2"
    PERSONAL_NUMBER_FIELD_NAME: "PersonalNumber"
    PERSONAL_NUMBER_FIELD_NAME_NORMALIZED: "MRZ.PersonalNumber"
    PIN_CODE_FIELD_NAME: "PINCode"
    PIN_CODE_FIELD_NAME_NORMALIZED: "MRZ.PINCode"
    SURNAME_FIELD_NAME: "Surname"
    SURNAME_FIELD_NAME_NORMALIZED: "MRZ.Surname"
    TRAVEL_DOC_TYPE_FIELD_NAME: "TravelDocType"
    TRAVEL_DOC_TYPE_FIELD_NAME_NORMALIZED: "MRZ.TravelDocType"
    TRAVEL_DOC_TYPE_VARIANT_FIELD_NAME: "TravelDocTypeVariant"
    TRAVEL_DOC_TYPE_VARIANT_FIELD_NAME_NORMALIZED: "MRZ.TravelDocTypeVariant"
    UNKNOWN_FIELD_NAME: "Unknown"
    UNKNOWN_FIELD_NAME_NORMALIZED: "MRZ.Unknown"
    VERSION_NUMBER_FIELD_NAME: "VersionNumber"
    VERSION_NUMBER_FIELD_NAME_NORMALIZED: "MRZ.VersionNumber"
    VISA_OPTIONAL_FIELD_NAME: "VisaOptional"
    VISA_OPTIONAL_FIELD_NAME_NORMALIZED: "MRZ.VisaOptional"

    Accessors

    • get checkDigitBirthDate(): Field | undefined

      Check digit birth date

      Returns Field | undefined

    • get checkDigitDocumentNumber(): Field | undefined

      Check digit document number

      Returns Field | undefined

    • get checkDigitExpiryDate(): Field | undefined

      Check digit expiry date

      Returns Field | undefined

    • get checkDigitGeneral(): Field | undefined

      Check digit general

      Returns Field | undefined

    • get checkDigitPersonalNumber(): Field | undefined

      Check digit personal number

      Returns Field | undefined

    • get dateOfIssuance(): Field | undefined

      Date of issuance

      Returns Field | undefined

    • get documentNumber(): Field | undefined

      Document number

      Returns Field | undefined

    • get documentType(): Field

      Document type from the DocumentType enum

      Returns Field

    • get documentTypeCode(): Field | undefined

      Document type code

      Returns Field | undefined

    • get expiryDate(): Field | undefined

      Expiry date

      Returns Field | undefined

    • get gender(): Field | undefined

      Gender

      Returns Field | undefined

    • get issuingAuthority(): Field | undefined

      Issuing authority

      Returns Field | undefined

    • get languageCode(): Field | undefined

      Language code

      Returns Field | undefined

    • get officeOfIssuance(): Field | undefined

      Office of issuance

      Returns Field | undefined

    • get optional1(): Field | undefined

      TD1 Optional field (line 2)

      Returns Field | undefined

    • get optional2(): Field | undefined

      TD1 Optional field (line 3)

      Returns Field | undefined

    • get personalNumber(): Field | undefined

      Personal number

      Returns Field | undefined

    • get pinCode(): Field | undefined

      PIN code

      Returns Field | undefined

    • get travelDocType(): Field | undefined

      Travel document type

      Returns Field | undefined

    • get travelDocTypeVariant(): Field | undefined

      Travel document type variant

      Returns Field | undefined

    • get unknown(): Field | undefined

      Unknown

      Returns Field | undefined

    • get versionNumber(): Field | undefined

      Version number

      Returns Field | undefined

    • get visaOptional(): Field | undefined

      MRV-A/MRV-B (Travel Visa) Optional field

      Returns Field | undefined

    Methods

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    BIRTH_DATE_FIELD_NAMEBIRTH_DATE_FIELD_NAME_NORMALIZEDCHECK_DIGIT_BIRTH_DATE_FIELD_NAMECHECK_DIGIT_BIRTH_DATE_FIELD_NAME_NORMALIZEDCHECK_DIGIT_DOCUMENT_NUMBER_FIELD_NAMECHECK_DIGIT_DOCUMENT_NUMBER_FIELD_NAME_NORMALIZEDCHECK_DIGIT_EXPIRY_DATE_FIELD_NAMECHECK_DIGIT_EXPIRY_DATE_FIELD_NAME_NORMALIZEDCHECK_DIGIT_GENERAL_FIELD_NAMECHECK_DIGIT_GENERAL_FIELD_NAME_NORMALIZEDCHECK_DIGIT_PERSONAL_NUMBER_FIELD_NAMECHECK_DIGIT_PERSONAL_NUMBER_FIELD_NAME_NORMALIZEDDATE_OF_ISSUANCE_FIELD_NAMEDATE_OF_ISSUANCE_FIELD_NAME_NORMALIZEDDOCUMENT_NUMBER_FIELD_NAMEDOCUMENT_NUMBER_FIELD_NAME_NORMALIZEDDOCUMENT_TYPEDOCUMENT_TYPE_CODE_FIELD_NAMEDOCUMENT_TYPE_CODE_FIELD_NAME_NORMALIZEDDOCUMENT_TYPE_FIELD_NAMEDOCUMENT_TYPE_FIELD_NAME_NORMALIZEDEXPIRY_DATE_FIELD_NAMEEXPIRY_DATE_FIELD_NAME_NORMALIZEDGENDER_FIELD_NAMEGENDER_FIELD_NAME_NORMALIZEDGIVEN_NAMES_FIELD_NAMEGIVEN_NAMES_FIELD_NAME_NORMALIZEDISSUING_AUTHORITY_FIELD_NAMEISSUING_AUTHORITY_FIELD_NAME_NORMALIZEDLANGUAGE_CODE_FIELD_NAMELANGUAGE_CODE_FIELD_NAME_NORMALIZEDNATIONALITY_FIELD_NAMENATIONALITY_FIELD_NAME_NORMALIZEDOFFICE_OF_ISSUANCE_FIELD_NAMEOFFICE_OF_ISSUANCE_FIELD_NAME_NORMALIZEDOPTIONAL_1_FIELD_NAMEOPTIONAL_1_FIELD_NAME_NORMALIZEDOPTIONAL_2_FIELD_NAMEOPTIONAL_2_FIELD_NAME_NORMALIZEDPERSONAL_NUMBER_FIELD_NAMEPERSONAL_NUMBER_FIELD_NAME_NORMALIZEDPIN_CODE_FIELD_NAMEPIN_CODE_FIELD_NAME_NORMALIZEDSURNAME_FIELD_NAMESURNAME_FIELD_NAME_NORMALIZEDTRAVEL_DOC_TYPE_FIELD_NAMETRAVEL_DOC_TYPE_FIELD_NAME_NORMALIZEDTRAVEL_DOC_TYPE_VARIANT_FIELD_NAMETRAVEL_DOC_TYPE_VARIANT_FIELD_NAME_NORMALIZEDUNKNOWN_FIELD_NAMEUNKNOWN_FIELD_NAME_NORMALIZEDVERSION_NUMBER_FIELD_NAMEVERSION_NUMBER_FIELD_NAME_NORMALIZEDVISA_OPTIONAL_FIELD_NAMEVISA_OPTIONAL_FIELD_NAME_NORMALIZED
    Accessors
    Methods