Quick start

Step 1 – Request a license

To use the SDK, you need to get a license:

Step 2 – Install the SDK

  1. Download the archive on our cloud drive (the link should provided by our sales department)

  2. Uncompress the archive.

SDK Archive

id3 Document SDK is delivered as a compressed archive (ZIP file) that contains the following directories and files:

├───activation                      # License activation tools
│   ├───cli-tool
│   └───windows-tool
├───bin                             # Native libraries
│   ├───android
│   ├───apple
│   ├───linux
│   └───windows
├───dart                            # Dart wrapper source code
│   └───id3_document
├───docs                            # API reference and Developer Guide
│   ├───3rdparty
│   ├───developer-guide
│   ├───javadoc
├───dotnet                          # .NET dynamic libraries
├───include                         # C header files
├───java                            # Java jar archives
├───python                          # Python package
├── CHANGELOG.md
├── LICENSE.md
└── README.md

Installing the Python package

Select the suitable wheel file for our platform and Python version, and run

pip install id3document-x.y.z-cp311-cp311-win_amd64.whl

Step 3 – Download the AI models

id3 Document SDK requires AI models to run. They are common to every platform and should be distributed according to the application’s needs.

Important

Models can be downloaded at the following URL:
https://cloud.id3.eu/index.php/s/JYJGbn9maingpF9

See AI Models for details.

Step 4 – Run the samples

id3 Document SDK contains sample projects for the following programming platforms and languages:

  • Windows, Linux (C/C++)

  • .NET (C#)

  • Flutter (Dart)

  • Android (Kotlin + Java)

  • iOS (Swift)

Note

Those samples are not delivered in the ZIP archive.
They can be found directly here: https://github.com/id3Technologies/sdk-samples

Samples demonstrate how to use the main functionalities of the id3 Document SDK, including:

  • Detection of a document in an image

  • Reading of the fields inside the document

  • Independent MRZ reading from any document