Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for iOS

Run the samples

The Scandit Barcode Scanner SDK comes with seven demos:

  • SimpleSample: shows how to use the barcode scanner in Objective-C
  • SwiftSample: shows how to use the barcode scanner in Swift
  • ExtendedSample: allows the user to configure the barcode scanner as well as the UI from the application itself.
  • MatrixScanSample: shows how to use MatrixScan.
  • BatchModeScanSample: shows how to implement aim-and-scan or scan-and-confirm, to precisely select a barcode among many others.
  • ViewBasedMatrixScanSample: shows how to implement view overlays on top of a barcode with MatrixScan.
  • GeneratorSample: shows how to use our barcode generator.

This guide shows you how to run these sample applications. It is assumed that you have a recent version of XCode installed on your development machine.

To build and run the Scandit demo project, perform the following four steps.

Download the Scandit Barcode Scanner

Choose a plan (e.g., free “Enterprise Trial” or "Community" plan) at, activate your account and log in. Go to the Download section and download the Barcode Scanner for iOS.

Framework Download

Open the simple demo project in Xcode

Unpack the downloaded ZIP file and open the SimpleSample/SimpleSample.xcodeproj demo project in Xcode.

Contents of sample project

Set license key

Sign in to your account at to look up your license key in the License Key section.

App Key in your account

In the AppKey.h file, locate the following constant string and paste your license key between the quotation marks.

Add your app key

Build and run the project

You can now build and run the demo project on your iPhone device.

Next steps

Integrate the Scandit SDK into your app