Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# id3 Document API

id3 Document SDK provides an easy to use programming interface available in various languages.

{description}

It includes:

## Classes

DetectedDocument | Represents a detected document.
DocumentAuthenticator | Verifies the authenticity of a document using security features such as holograms.
DocumentDetector | Detects documents in images.
DocumentImage | Represents a document image.
DocumentInfo | Represents document information.
DocumentInfoDictionary | Represents a dictionary of document information.
DocumentLibrary | Initializes the SDK library.
DocumentLicense | Manages the license for this SDK.
DocumentReader | Reads text field on a document using optical character recognition (OCR).
HologramAuthenticationResult | Represents the result of hologram authentication.
HologramAuthenticationResultList | Represents a list of hologram authentication results.
ImageBuffer | Represents an image buffer.
MrzHelper | Provides functionalities to decode and check a MRZ.
MrzReader | Detects and reads an MRZ in an image.
MrzReadingResult | Represents the result of MRZ reading.
PointList | Represents a point list.
StringDict | Represents a string dictionary.
StringList | Represents a string lists.
TextField | Represents a text field extracted from a document.
TextFieldList | Represents a list of text fields extracted from a document.

## Enumerations

DocumentCategory | Enumerates document categories.
DocumentError | Enumerates possible error codes.
DocumentFormat | Enumerates document formats, according to ISO/IEC 7810.
DocumentModel | Enumerates the AI models available in this SDK.
ImageError | Enumerates possible error codes related to image management.
ImageFormat | Enumerates supported image formats.
LicenseError | Enumerates the error codes related to license management.
LicenseHardwareCodeType | Enumerates the types of hardware codes.
LicenseType | Enumerates the license types.
MrzType | Enumerates supported MRZ types.
PixelFormat | Enumerates supported pixel formats.
ProcessingUnit | Enumerates processing units.

## Structures

DocumentOrientation | Represents the document orientation.
LibVersion | Contains data for LibVersion
Point | Represents a point.
Rectangle | Represents a rectangle.

## Exceptions

DocumentException | This exception is thrown when an error occurs in the id3 Document library.