Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Document SDK 2.1.2

- Introduction
  Toggle navigation of Introduction
  - Features
  - Technologies
  - Image formats
  - Supported documents
  - Programming languages
  - Terms and Definitions
- Requirements
- Quick start
- Licensing
  Toggle navigation of Licensing
  - License types
  - License modules
  - License activation
  - License hardware code
  - License manager
  - License repositionning
- Distribution

Reference

- Usage
  Toggle navigation of Usage
  - Naming conventions
  - Error handling
  - License handling
  - AI Models
  - Document database
  - Document detection
  - Document reading
  - MRZ reading
  - Document authenticity check
- id3 Document API
  Toggle navigation of id3 Document API
  - DetectedDocument
    Toggle navigation of DetectedDocument
    - bounds
    - clone
    - confidence
    - info
    - orientation
  - DocumentAuthenticator
    Toggle navigation of DocumentAuthenticator
    - appendFrame
    - authenticateHolograms
    - documentName
    - isFull
    - temporalWindowSize
  - DocumentCategory
  - DocumentDetector
    Toggle navigation of DocumentDetector
    - alignDocument
    - confidenceThreshold
    - detectDocument
    - detectDocumentByName
    - documentWidthRatio
    - model
    - processingUnit
    - threadCount
  - DocumentError
  - DocumentException
  - DocumentFormat
  - DocumentImage
    Toggle navigation of DocumentImage
    - clone
    - compare
    - correctGamma
    - crop
    - data
    - downscale
    - downscaleTo
    - extractRoi
    - extractRoiWithColor
    - flip
    - flipTo
    - fromBuffer
    - fromFile
    - fromNumpy
    - fromRawBuffer
    - fromYuvPlanes
    - getPixels
    - height
    - pad
    - pixelDepth
    - pixelFormat
    - reallocate
    - resize
    - resizeTo
    - rotate
    - rotateTo
    - set
    - stride
    - toBuffer
    - toBufferObject
    - toFile
    - toNumpy
    - toRawBuffer
    - transpose
    - width
  - DocumentInfo
    Toggle navigation of DocumentInfo
    - category
    - clone
    - country
    - date
    - description
    - format
    - identifier
    - mrzType
    - name
    - pageNumber
  - DocumentInfoDictionary
    Toggle navigation of DocumentInfoDictionary
    - add
    - clear
    - clone
    - containsKey
    - count
    - get
    - getCount
    - keys
    - remove
    - set
  - DocumentLibrary
    Toggle navigation of DocumentLibrary
    - getVersion
    - getVersionEx
    - loadDocumentTemplate
    - loadDocumentTemplateBuffer
    - loadModel
    - loadModelBuffer
    - unloadDocumentTemplate
    - unloadModel
  - DocumentLicense
    Toggle navigation of DocumentLicense
    - activate
    - activateActivationKey
    - activateActivationKeyBuffer
    - activateBuffer
    - activateSerialKey
    - activateSerialKeyBuffer
    - checkLicense
    - checkLicenseBuffer
    - checkLicenseBufferWithCard
    - checkLicenseWithCard
    - checkModule
    - finalizeCheckLicenseWithCard
    - getExpiryDate
    - getExternalDriveHardwareCode
    - getHostHardwareCode
    - getLicenseFileHardwareCode
    - getLicenseFileSerial
    - getLicenseName
    - getLicenseOwner
    - getLicensePath
    - getLicenseType
    - getModuleCount
    - getModuleName
    - getModuleValue
    - getProductReference
    - getRemainingDays
    - reactivate
    - reactivateBuffer
  - DocumentModel
  - DocumentOrientation
    Toggle navigation of DocumentOrientation
    - pitch
    - roll
    - yaw
  - DocumentReader
    Toggle navigation of DocumentReader
    - extractFace
    - readDocument
    - readField
    - threadCount
  - HologramAuthenticationResult
    Toggle navigation of HologramAuthenticationResult
    - bounds
    - clone
    - correlationScore
    - hologramName
    - variationScore
  - HologramAuthenticationResultList
    Toggle navigation of HologramAuthenticationResultList
    - add
    - clear
    - clone
    - count
    - get
    - getCount
    - removeAt
    - resize
    - set
  - ImageBuffer
    Toggle navigation of ImageBuffer
    - clone
    - getData
    - getPixels
  - ImageError
  - ImageFormat
  - LibVersion
    Toggle navigation of LibVersion
    - build
    - major
    - minor
  - LicenseError
  - LicenseHardwareCodeType
  - LicenseType
  - MrzHelper
    Toggle navigation of MrzHelper
    - check
    - decode
  - MrzReader
    Toggle navigation of MrzReader
    - binarizationMethod
    - model
    - processingUnit
    - readMrz
    - threadCount
  - MrzReadingResult
    Toggle navigation of MrzReadingResult
    - bounds
    - clone
    - confidence
    - mrz
    - mrzType
  - MrzType
  - PixelFormat
  - Point
    Toggle navigation of Point
    - x
    - y
  - PointList
    Toggle navigation of PointList
    - add
    - clear
    - clone
    - count
    - get
    - getCount
    - removeAt
    - resize
    - set
  - ProcessingUnit
  - Rectangle
    Toggle navigation of Rectangle
    - bottomLeft
    - bottomRight
    - topLeft
    - topRight
  - StringDict
    Toggle navigation of StringDict
    - add
    - clear
    - clone
    - containsKey
    - count
    - get
    - getCount
    - keys
    - remove
    - set
  - StringList
    Toggle navigation of StringList
    - add
    - clear
    - clone
    - count
    - get
    - getCount
    - removeAt
    - resize
    - set
  - TextField
    Toggle navigation of TextField
    - bounds
    - clone
    - confidence
    - name
    - value
  - TextFieldList
    Toggle navigation of 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
Toggle table of contents sidebar