Skip to main content

Introduction

Welcome to the QI Tech OCR (Optical Character Recognition) SDK integration manual for React Native! The @qitech/react-native-caas module exposes QI Tech's native Android (Java/Kotlin) and iOS (Swift) SDKs through a TypeScript interface. You can use it to capture, through your application, an image of your customer's document to be recognized, such as a Driver's License or ID card, and reference it through a key in the other products of the QI Tech system.

Available packages​

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

Both packages include Device Scan. Do not install both — choose only one.

For OCR, use @qitech/react-native-caas.

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 first parameter of the startOcr function. At the moment, the following environments are available:

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

Each environment requires a different Mobile 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 — a complete startOcr example.
  4. The OcrOptions object — every customization parameter.
  5. Collecting the Responses — response structure and error handling.