React Native SDK

Installation

$ npm install --save react-native-webview
$ npm install --save react-native-pinwheel

# iOS only
$ cd ios && pod install

You can find the npm package here.

Configuration

Some platform integrations may require camera access for verification purposes. Ensure the necessary permissions are configured in your project:

Android: Add the following permission to your AndroidManifest.xml:

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

iOS: Add the following key and description to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>We need access to your camera for verification purposes.</string>

Usage

The PinwheelLink component is a view that you can integrate into your app's flow. The Link token and optional callback handlers are passed in as props.

import PinwheelLink from "react-native-pinwheel";

<PinwheelLink linkToken={token} />;

You can see a full list of props and optional callbacks here.

Maintenance

Pinwheel regularly releases improvements to this SDK. You should update to the latest version of the React Native SDK at least quarterly to ensure the best product performance.