Skip to main content

License handling

License key​

In order to run the Scanbot SDK within your production app, you must purchase and use a valid Scanbot SDK license.

Each license key is valid only for a given app bundle identifier. You will be unable to use any of the SDK features if the license key is corrupted, expired, or invalid in any other way.

Trial license​

The Scanbot SDK will run without a license for one minute per session! To get a free, "no-strings-attached" 7-day trial license, please submit the Trial License Form on our website.

Please kindly note that a trial license can only be used in a development and staging environment. You are not allowed to publish your app to the App Store, Play Store, or any 3rd party Android App Store with a trial license.

Purchase a production license​

To get pricing information and purchase a production license for the Scanbot SDK, please request a quote.

License checks in production apps​

If your Scanbot Document Scanner SDK license has expired, any call to the Scanbot Document Scanner SDK API will not work. You should always check for license expiration during the runtime by using one of the following methods:

  • +[Scanbot isLicenseValid] This method returns a simple boolean flag. false means the license is not valid or has expired and you should disable any usage of the Scanbot Document Scanner SDK functions or UI components.
  • +[ScanbotSDK licenseStatus] This methods returns more details about the status of the current license key.

We highly recommend implementing a suitable handling of this case in your app!

Example code for checking the license status:

if ([Scanbot isLicenseValid]) {
    // Making your call to the Scanbot Document Scanner SDK API is now safe.
    // E.g. launch the Document Scanner UI, detecting documents on an image, etc ...
}

Updating the license in production apps​

The expiration date and the feature list of a license are contained in an encrypted data part of the license key string. This means a renewal or extension of a license will cause a new license key string to be generated.

To renew an expired license or extend a valid license with additional Scanbot SDK features, you will have to deploy a new version of the app with updated license key.

Alternatively, the new key may be dispatched via Firebase Remote Config or loaded from your Web API, but we do not provide an out-of-the box solution for this.

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get your free Trial License

What do you think of this documentation?

On this page

Scroll to top