Skip to main content

Initializing the React Native Data Capture Modules

License key​

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.

Example code for defining and using the license key:

Initialize with license key
loading...

Getting a trial license​

The Scanbot SDK will run without a license for one minute per session.

To get a free 7-day trial license, please submit the trial license form.

Please note that a trial license may 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 third-party 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.

App identifier​

Every app has a unique identifier (also known as "bundle identifier" or "application ID"). Your license will be bound to this identifier.

To request a trial license or purchase a production license, you need to provide the app identifier of your application.

Initialization​

Free Developer Support

We provide free technical support for the implementation and testing of the Scanbot SDK. If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate framework or features, please send us an email.

ScanbotSDK.initializeSDK(options)

The Scanbot SDK must be initialized before usage. Make sure to run the initialization only once per app lifetime. This should ideally be done at the earliest point in the application's lifecycle.

Typically, doing this in the App.tsx file is good practice because it ensures that the Scanbot SDK is ready for use as soon as the app starts.

Initialize ScanbotSDK
loading...
Initialize ScanbotSDK hook
loading...

For a complete list of initialization properties, please refer to the API documentation.

Logging​

When initializing the Scanbot SDK, you have the option to enable logging. By default, logging is disabled.

Initialize with logging enabled
loading...

On Android, logs are printed into LogCat and saved on the device. You can find them in Environment.getExternalStorageDirectory()/debug_logs/[package_name] (usually /sdcard/debug_logs/[package_name]).

The easiest way to check the log outputs on Android is to use the Android Debug Bridge (adb) (e.g., $ adb -s <DEVICE_ID> shell "logcat").

On iOS, all logs are printed to the console. Please use Xcode to check the log outputs.

You can also see application logs in the terminal by issuing react-native log-android or react-native log-ios.

No log files are created by the Scanbot SDK itself.

warning

While it is useful for development, we recommend disabling logging in production builds for security and performance reasons.

Image quality/compression​

initializeSDK can take two more optional parameters that specify the image storage format and compression for JPEG images created by the Document Scanner, Cropping UI, and image manipulation functions like applyImageFilter.

Initialize with image quality
loading...
  • storageImageFormat: Either 'JPG' or 'PNG'. The default value is 'JPG'.
  • storageImageQuality: Defines the quality factor of JPEG images. The value must be between 1 and 100, where 100 means maximum quality and the largest file size. This parameter is optional. The default value is 80, which is a good compromise between image file size and document legibility.

Want to scan longer than one minute?

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

Get free trial license

On this page