# react-native-caisson

> Caisson ID Check SDK

Latest version **0.1.8** (published 2020-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-caisson
pnpm add react-native-caisson
yarn add react-native-caisson
bun add react-native-caisson
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2020-06-03 |
| First published | 2020-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 100.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Caisson |
| Maintainers | caisson_techact, derekg, kenlittle, noamcaisson, pausantesmasses |

## Links

- npm: https://www.npmjs.com/package/react-native-caisson
- npm.io page: https://npm.io/package/react-native-caisson

## Recent versions

- 0.1.8 (latest) — 2020-06-03
- 0.1.7 — 2020-05-11
- 0.1.6 — 2020-05-09
- 0.1.5 — 2020-04-27
- 0.1.4 — 2020-03-31
- 0.1.3 — 2020-03-31

## README

# 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:

```xml
<!-- 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:

```xml
<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

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

To render the component, simply add `<CaissonIDCheck>`:

```jsx
<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](https://www.caisson.com/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

---
_Source: https://npm.io/package/react-native-caisson · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._