Skip to main content

Introduction

Welcome to the QI Tech Device Scan integration manual for React Native! The @qitech/react-native-device-scan module exposes QI Tech's native Android (Java/Kotlin) and iOS (Swift) SDKs through a TypeScript interface. You should use it to collect information from the phone and user behavior in your application, thus improving the accuracy of decisions.

Available packages​

PackageContentsWhen to use
@qitech/react-native-device-scanDevice Scan onlyWhen you need only device scan — a lighter installation with fewer native dependencies.
@qitech/react-native-caasFace Recognition, OCR and Device ScanWhen you also need face recognition or OCR.
Important Note!

Both packages include Device Scan and expose the same startDeviceScan function, with the same signature. Do not install both — choose only one.

This section documents @qitech/react-native-device-scan. If your application already uses @qitech/react-native-caas, just change the import path — everything else in this documentation applies unchanged.

Having issues?​

We are not a company that hides behind an API! Contact our support and we will respond as quickly as possible. Feel free to call us if you want a quick response!

We love feedback​

Even if you have already solved your problem or if it is very simple (even a typo or poor organization that you already understood), send us an email—this way we make the documentation more and more practical and the next person won't have to suffer the pains you suffered!

Environments​

We have two environments for our customers. The selection is made through the CAAS_ENVIRONMENT enum, passed as the last parameter of the startDeviceScan function. At the moment, the following environments are available:

  • Production - CAAS_ENVIRONMENT.PRODUCTION
  • Sandbox - CAAS_ENVIRONMENT.SANDBOX

Each environment requires a different API key to generate the token.

Important Note!

Do not use real personal or corporate data in QI Tech's Sandbox environments.

Next steps​

  1. Compatibility — minimum React Native, iOS and Android versions.
  2. Installation — package installation and native Android, iOS and Expo setup.
  3. Implementation — obtaining the token and a complete startDeviceScan example.
  4. The startDeviceScan function — parameters and return values.
  5. Permissions — permissions that broaden the data collection.