react-native-caisson v0.1.8

React Native SDK

The Caisson React Native SDK is the easiest way to implement Caisson ID Check on your React Native app. The SDK provides a seamless user experience, taking the user through the ID Check process right within the app and notifying your app when the process is complete.

Installation

$ npm install react-native-caisson --save

Install peer dependencies

Caisson RN library has the following peer dependencies:

react-native-orientation-locker
react-native-camera

iOS

Add the following to info.plist:

<!-- Required with iOS 10 and higher -->

<key>NSCameraUsageDescription</key>
<string>We need access to your camera so we can check your ID</string>

Android

Add permissions to your app android/app/src/main/AndroidManifest.xml file:

<uses-permission android:name="android.permission.CAMERA" />

Insert the following lines in android/app/build.gradle:

android {
  ...
  defaultConfig {
    ...
    // Insert this line below
    missingDimensionStrategy 'react-native-camera', 'general'
  }
}

Usage

import {CaissonIDCheck} from 'react-native-caisson';

To render the component, simply add <CaissonIDCheck>:

<CaissonIDCheck
  apiKey="<your public Caisson API key>"
  onIDCheckCreated={idCheck => console.log(idCheck)}
  onIDCheckCompleted={() => console.log('idCheckCompleted')}
/>

Required props

• apiKey: your public Caisson API key. The API key can be found in the Caisson Portal Developer panel
• onIDCheckCreated: a function that will be invoked when the ID Check is created. The function will be called with the idCheck object as a parameter. Use the idCheck object to exchange the temporary exchange token for a permanent ID Check query token. For more details, see the Caisson docs.
• onIDCheckCompleted: a function that will be invoked when the ID Check is complete. You can then use your server to query for the results of the ID Check.

Optional props

• customerID: string customer ID to be displayed in the Caisson console
• color: your brand color
• visible: boolean whether to show the ID Check dialog or not