SDK versioning policy

Introduction​

We strongly recommend keeping your SDK integrations up to date. Newer SDK versions consistently deliver better scanning accuracy, improved fraud detection, expanded document coverage, and compatibility with the latest OS versions and devices.

Versioning schemes​

Microblink SDKs use two versioning schemes: epoch versioning and semantic versioning. The scheme in use depends on the product; see the Products overview below.

Epoch versioning​

Epoch versioning uses the format (EPOCH × 1000 + MAJOR).MINOR.PATCH. The first number encodes both the epoch and the major release, making the architectural generation of the SDK immediately visible from the version number alone.

For example, v3000.0.0 means epoch 3, major 0, minor 0, patch 0. The next breaking change within epoch 3 would be v3001.0.0, while a new epoch would start at v4000.0.0.

• Epoch: Reserved for fundamental architectural rewrites, a platform-level shift in how the SDK is structured or integrated. An epoch increment resets the major component to 0.
• Major: Contains breaking changes to the integration interface within the current epoch. Migration guides are provided for every major release.
• Minor: Adds new features in a backward-compatible manner. No changes to the existing integration interface.
• Patch: Delivers bug fixes and security updates without breaking changes.

Semantic versioning​

Semantic versioning uses the standard MAJOR.MINOR.PATCH format as defined at semver.org.

• Major: Contains one or more incompatible changes to the integration interface. Migration guides are provided for every major release.
• Minor: Adds new features, document support, or capabilities in a backward-compatible manner.
• Patch: Delivers bug fixes and security patches without breaking changes.

Products overview​