Client SDKs

React Native SDK

sprintcheckrn wraps the native Android and iOS verification flows behind a promise-based JavaScript API — BVN, NIN and facial verification.

v1.1.4TypeScriptsprintcheckrnnpm

Install

Terminal

npm install sprintcheckrn
# or
yarn add sprintcheckrn

The package contains native code, so rebuild after installing. Autolinking covers React Native 0.60+; on iOS run npx pod-install first.

Rebuild

# iOS
npx pod-install
npx react-native run-ios

# Android
npx react-native run-android

On Android, Gradle must be able to resolve the liveness engine — add these repositories to android/settings.gradle:

android/settings.gradle

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://jitpack.io") }
        maven { url = uri("https://maven.regulaforensics.com/RegulaDocumentReader") }
    }
}

Initialize & verify

JavaScript

import SprintCheck from 'sprintcheckrn';

// Initialize once with your keys
await SprintCheck.initialize(SPRINTCHECK_API_KEY, SPRINTCHECK_ENCRYPTION_KEY);

// Launch a flow — each resolves with the verification result
const bvn = await SprintCheck.startBvnVerification('user@email.com');
const nin = await SprintCheck.startNinVerification('user@email.com');
const face = await SprintCheck.startFacialVerification('user@email.com');

The SDK needs your api_key and encryption_key — both are under Developers in your dashboard. Every completed verification also lands on your webhook and in your dashboard's verification history.