DocumentationAPI Reference
DocumentationAPI Reference

React Native SDK v2 Integration

🚧

v1 or v2?

If your Template ID starts with itmpl_, you're in the right place. Otherwise, you will want to look at the v1 section. If you are interested in moving to v2, please contact [email protected]

❗️

Cocoapods 1.9.3 is incompatible

Cocoapods 1.9.3 has a bug that prevents builds from selecting the correct architecture. See more details here: https://github.com/CocoaPods/CocoaPods/pull/9790.

To install, please downgrade to 1.8.x or upgrade to 1.10.x

Installation

Inquiry SDK latestInquiry SDK latest
To install the Persona React Native SDK within your React Native application, if you use yarn to manage your project dependencies

yarn add react-native-persona

If you use npm to manage your project dependencies

npm i react-native-persona

Add Android Maven repository

Open your android/build.gradle file. Add the Persona Maven repository to the bottom of your repository list.

allprojects {
    repositories {
        // ...
        maven { 
            url 'https://sdk.withpersona.com/android/releases'
        }
    }
}

Install iOS pods

cd ios; pod install

iOS Permissions

Ensure access to the Camera within your iOS app.

Modify your Info.plist:

Navigate to your project’s settings in Xcode and click the Info tab
Add a new Privacy - Camera Usage Description entry (if not already present) to enable camera access.

iOS minimum deployment target

Our native iOS SDK requires a minimum iOS deployment target of 11.0.

In your project's ios/Podfile, ensure your platform target is set to 11.0.

platform :ios '11.0'

iOS frameworks support

🚧

Ensure use_frameworks! is within your ios/Podfile.

Recent versions of React Native project generators should have this included by default. If you have been incrementally updating your React Native project from older versions, however, you may need to add this.

Without use_frameworks! the SDK will fail to compile due to problems importing Lottie, which is a dependency of the SDK.

Usage

The Persona Inquiry flow can be initiated with either a template ID or an inquiry ID.

Please refer to the code sample below and replace my_template_id with your template ID. You can find your template ID on the Persona Dashboard under Integration.

This starts the Inquiry flow and takes control of the user interface. Once the flow completes, the control of the user interface is returned to the app and the appropriate callbacks are called.

const InquiryLauncher = ({templateId}) => {
  const handleBeginInquiry = useCallback(() => {
    Inquiry.fromTemplate(templateId)
      .environment(Environment.SANDBOX)
      .onComplete((inquiryId, status, fields) => {
        console.log("Inquiry #{inquiryId} completed with status #{status}");
      })
      .onCanceled((inquiryId, sessionToken) => {
        console.log("Inquiry #{inquiryId} canceled.");
      })
      .onError(debugMessage => {
        console.error(debugMessage);
      })
      .build()
      .start();
  }, [templateId])

  return (
    <Button onPress={handleBeginInquiry} title="Start inquiry" />
  )
}

Inquiry Attributes

The onSuccess callback returns attributes, which is an object containing information extracted during the inquiry. The attributes object includes birthdate, name, and address.

Configuration options

Some different configuration example can be found below

// Configuration with only a template ID
Inquiry.fromTemplate("itmpl_Ygs16MKTkA6obnF8C3Rb17dm").build().start();

// Configuration with only a template ID in the sandbox
Inquiry.fromTemplate("itmpl_Ygs16MKTkA6obnF8C3Rb17dm")
   .environment(Environment.SANDBOX)

// Configuration with a template and reference ID
Inquiry.fromTemplate("itmpl_Ygs16MKTkA6obnF8C3Rb17dm")
   .referenceId("myReference")
   .build()
   .start();

// Configuration with a template and account ID
Inquiry.fromTemplate("itmpl_Ygs16MKTkA6obnF8C3Rb17dm")
    .accountId("act_W6thEnEU19gphPqq5uTzZ4Y8")
    .build()
    .start();

// Configuration passing fields into the request
Inquiry.fromTemplate("itmpl_Ygs16MKTkA6obnF8C3Rb17dm")
  .fields(
    Fields.builder()
      .string('nameFirst', 'Alexander')
      .string('nameLast', 'example')
      .build(),
  )
  .build()
  .start();

// Configuration with only an inquiry ID
Inquiry.fromInquiry("inq_JAZjHuAT738Q63BdgCuEJQre").build().start();

// Configuration resuming an inquiry session with an access token 
Inquiry.fromInquiry("inq_JAZjHuAT738Q63BdgCuEJQre")
    .sessionToken("SOME_SESSION_TOKEN")
    .build()
    .start();

Theming

In order to theme the experience, use the persona-tool to customize the colors of Persona Inquiry flow. The tool itself acts as a guide to walk you through theming your experience.

# yarn
yarn persona-tool

# npm
npx persona-tool

Follow the instructions provided by the theming tool to set up the proper configuration. Themes will need to be configured separately for iOS and Android.

For more information on theming, view React Native SDK v2 Theming.