Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Scanbot SDK Example App for Cordova with Ionic

This example app demonstrates how to integrate the Scanbot SDK Cordova Plugin in a Cordova app using the Ionic Framework.

The Scanbot SDK Cordova Plugin is available as npm package.

For more details about the Plugin please see this documentation.

What is Scanbot SDK?

The Scanbot SDK brings scanning and document creation capabilities to your mobile apps. It contains modules which are individually licensable as license packages. For more details visit our website

How to run this app

Install the latest versions of Cordova and Ionic. Fetch this repository and navigate to the project directory.

cd scanbot-sdk-example-ionic/

Install node modules:

npm install

Install Cordova platforms and plugins (defined in the config.xml of this app):

cordova prepare

Check installed platforms and plugins:

cordova platform ls

cordova plugin ls

You should see android and ios as installed platforms and cordova-plugin-scanbot-sdk as installed plugins.

Connect a device via USB and run the app.


ionic cordova run android


ionic cordova prepare ios

Open the project platforms/ios/Scanbot SDK Example Ionic.xcworkspace in Xcode and check/adjust the following settings:

  • Provisioning and Code Signing - see Cordova docs
  • Make sure the ScanbotSDK.framework was properly added as Embedded Binary

Then build and run the app in Xcode.

Please note

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

After the trial period has expired all Scanbot SDK functions as well as the UI components (like Document Scanner UI) will stop working or may be terminated. You have to restart the app to get another trial period.

To get an unrestricted, "no-strings-attached" 30-day trial license, please submit the Trial License Form on our website.