Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Document SDK 2.2.2
Light Logo Dark Logo
Document SDK 2.2.2
  • Introduction
  • Requirements
  • Quick start
  • Licensing
  • Distribution

Usage

  • Overview
  • Error handling
  • License handling
  • AI Models
  • Document database
  • Document detection
  • Document reading
  • MRZ reading
  • Document authenticity check

Reference

  • Document API
    • DetectedDocument
      • bounds
      • clone
      • confidence
      • info
      • orientation
    • DocumentAuthenticator
      • appendFrame
      • authenticateHolograms
      • documentName
      • isFull
      • temporalWindowSize
    • DocumentCategory
    • DocumentDetector
      • alignDocument
      • confidenceThreshold
      • detectDocument
      • detectDocumentByName
      • documentWidthRatio
      • model
      • processingUnit
      • threadCount
    • DocumentError
    • DocumentException
    • DocumentFormat
    • DocumentImage
      • cannyEdgeDetection
      • cannyEdgeDetectionTo
      • changeAspectRatio
      • changeAspectRatioWithColor
      • clone
      • compare
      • convertToGrayscale
      • convertToGrayscaleTo
      • correctGamma
      • crop
      • cropCenter
      • data
      • dilate
      • dilateTo
      • downscale
      • downscaleTo
      • equalizeHistogram
      • equalizeHistogramTo
      • erode
      • erodeTo
      • extractRoi
      • extractRoiWithColor
      • flip
      • flipTo
      • fromBuffer
      • fromFile
      • fromNumpy
      • fromRawBuffer
      • fromYuvPlanes
      • gaussianBlur
      • gaussianBlurTo
      • getPixels
      • height
      • medianBlur
      • medianBlurTo
      • normalize
      • normalizeQuantile
      • normalizeQuantileTo
      • normalizeTo
      • pad
      • padCenter
      • padCenterWithColor
      • pixelDepth
      • pixelFormat
      • reallocate
      • resize
      • resizeTo
      • rotate
      • rotateTo
      • set
      • sizeInBytes
      • stride
      • toBuffer
      • toBufferObject
      • toFile
      • toNumpy
      • toRawBuffer
      • transpose
      • width
    • DocumentInfo
      • category
      • clone
      • country
      • date
      • description
      • format
      • identifier
      • mrzType
      • name
      • pageNumber
    • DocumentInfoDictionary
      • add
      • clear
      • clone
      • containsKey
      • count
      • get
      • getCount
      • keys
      • remove
      • set
    • DocumentLibrary
      • getLoadedDocumentTemplate
      • getVersion
      • getVersionEx
      • loadDocumentTemplate
      • loadDocumentTemplateBuffer
      • loadModel
      • loadModelBuffer
      • unloadDocumentTemplate
      • unloadModel
    • DocumentLicense
      • activate
      • activateActivationKey
      • activateActivationKeyBuffer
      • activateBuffer
      • activateSerialKey
      • activateSerialKeyBuffer
      • checkLicense
      • checkLicenseBuffer
      • checkLicenseBufferWithCard
      • checkLicenseWithCard
      • checkModule
      • clearDeviceLicense
      • encrypt
      • finalizeCheckLicenseWithCard
      • getApplicationHardwareCode
      • getExpiryDate
      • getExternalDriveHardwareCode
      • getHostHardwareCode
      • getIdBoxDebugLog
      • getLicenseComment
      • getLicenseCycle
      • getLicenseFileHardwareCode
      • getLicenseFileSerial
      • getLicenseName
      • getLicenseOwner
      • getLicensePath
      • getLicenseType
      • getModuleCount
      • getModuleName
      • getModuleValue
      • getProductReference
      • getRemainingDays
      • reactivate
      • reactivateBuffer
      • setIdBoxUsbFd
    • DocumentModel
    • DocumentOrientation
      • pitch
      • roll
      • yaw
    • DocumentReader
      • computeBlurrinessScore
      • extractFace
      • readDocument
      • readField
      • threadCount
    • HologramAuthenticationResult
      • bounds
      • clone
      • correlationScore
      • hologramName
      • variationScore
    • HologramAuthenticationResultList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • ImageBuffer
      • clone
      • getData
      • getPixels
      • sizeInBytes
    • ImageError
    • ImageFormat
    • LibVersion
      • build
      • major
      • minor
    • LicenseCycle
    • LicenseError
    • LicenseHardwareCodeType
    • LicenseType
    • MrzHelper
      • check
      • decode
    • MrzReader
      • binarizationMethod
      • model
      • processingUnit
      • readMrz
      • threadCount
    • MrzReadingResult
      • bounds
      • clone
      • confidence
      • mrz
      • mrzType
    • MrzType
    • PixelFormat
    • Point
      • x
      • y
    • PointList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • ProcessingUnit
    • Rectangle
      • bottomLeft
      • bottomRight
      • clipInsideImage
      • clone
      • extend
      • fromPoints
      • fromXywh
      • fromXyxy
      • getEnglobingRectangle
      • getHeight
      • getWidth
      • getX
      • getY
      • isAligned
      • resize
      • topLeft
      • topRight
    • StringDict
      • add
      • clear
      • clone
      • containsKey
      • count
      • get
      • getCount
      • keys
      • remove
      • set
    • StringList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • TextField
      • bounds
      • clone
      • confidence
      • name
      • value
    • TextFieldList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set

ABOUT

  • Release notes
  • License agreement
  • Third-Party Libraries
  • Frequently Asked Questions
  • Troubleshooting
Back to top

MrzReader Class¶

Namespace: id3.Document

Definition¶

Detects and reads an MRZ in an image.

Properties¶

Name

Type

Description

binarizationMethod

int

Selection of the binarization method internally used in the algorithm.

model

DocumentModel

AI model used to detect the MRZ.

processingUnit

ProcessingUnit

Processing unit where to run the detection process.

threadCount

int

Number of threads to use for reading.

Methods¶

Name

Description

readMrz

Detects and reads an MRZ in an image.

Next
MrzReader.binarizationMethod Property
Previous
MrzHelper.decode Method
Copyright © 2026, id3 Technologies
Made with Furo
On this page
  • MrzReader Class
    • Definition
    • Properties
    • Methods