DEA SDK for React Native¶
Detect whether an app session comes from a real person. The SDK observes touch and device-motion input across your whole React Native app, natively on Android and iOS, and scores the session on the device.
On this page: Prerequisites · Install · Initialize the SDK · Ask for consent · Use the classification · Verify your setup · Before you release · Next steps
Prerequisites¶
- An
appIdandappKeyfor each platform's app — see Accounts and keys. On Android, also the Google Cloud project number DEA issued for Play Integrity — see Attest. - React Native 0.76 or later, with the New Architecture enabled. The SDK is a TurboModule and does not load on the old architecture.
- Android:
minSdkVersion24 (Android 7.0) or later - iOS: deployment target 15.1 or later
The SDK runs on Android and iOS. Other React Native targets (web, Windows, macOS) are not
supported: init rejects there.
Expo¶
Expo Go is not supported. The SDK contains native code that is not part of Expo Go.
The package ships no Expo config plugin, so npx expo prebuild does not add the iOS and Android
setup described below to the native projects it generates.
Install¶
Note:
@dea/react-nativeis installed from DEA's release URL, not from the npm registry. The URL names the release. The native SDKs it wraps come from the same release, set up as below.
npm¶
The JavaScript package wraps DEA's native Android and iOS SDKs. React Native's autolinking links
both bridges, Android and iOS. Each bridge depends on the native SDK at the same version as
@dea/react-native, which your app adds in the next two steps. To upgrade, install the URL of the
new release, then repeat both steps with the new version.
iOS setup¶
The iOS bridge depends on the DeaSDK pod, which depends on the DeaBase and
DeaAutomationDetection pods. DEA publishes them as Swift package archives, not on the CocoaPods
trunk, so your app downloads them and describes each one with a podspec.
-
From your app's root folder, download the archives:
-
Write these three podspecs in
ios/vendor/dea, beside the three folders:# ios/vendor/dea/DeaBase.podspec Pod::Spec.new do |s| s.name = 'DeaBase' s.version = '0.26.0' s.summary = 'DEA SDK: capture and shared types.' s.homepage = 'https://sdk.dep-protocol.com' s.license = { :type => 'Proprietary' } s.author = 'DEA' s.source = { :path => '.' } s.ios.deployment_target = '13.0' s.swift_version = '5.9' s.source_files = 'dea-base-0.26.0/Sources/DeaBase/**/*.swift' end# ios/vendor/dea/DeaAutomationDetection.podspec Pod::Spec.new do |s| s.name = 'DeaAutomationDetection' s.version = '0.26.0' s.summary = 'DEA SDK: automation detection.' s.homepage = 'https://sdk.dep-protocol.com' s.license = { :type => 'Proprietary' } s.author = 'DEA' s.source = { :path => '.' } s.ios.deployment_target = '13.0' s.swift_version = '5.9' s.source_files = 'dea-automation-detection-0.26.0/Sources/DeaAutomationDetection/**/*.swift' s.dependency 'DeaBase', s.version.to_s end# ios/vendor/dea/DeaSDK.podspec Pod::Spec.new do |s| s.name = 'DeaSDK' s.version = '0.26.0' s.summary = 'DEA SDK: scoring, the device key, proofs and models.' s.homepage = 'https://sdk.dep-protocol.com' s.license = { :type => 'Proprietary' } s.author = 'DEA' s.source = { :path => '.' } s.ios.deployment_target = '13.0' s.swift_version = '5.9' s.source_files = 'dea-sdk-0.26.0/Sources/DeaSDK/**/*.swift' s.dependency 'DeaBase', s.version.to_s s.dependency 'DeaAutomationDetection', s.version.to_s s.vendored_frameworks = 'dea-sdk-0.26.0/Frameworks/DeaCore.xcframework' core_headers = '"${PODS_XCFRAMEWORKS_BUILD_DIR}/DeaSDK/Headers"' s.pod_target_xcconfig = { 'SWIFT_INCLUDE_PATHS' => core_headers } s.user_target_xcconfig = { 'SWIFT_INCLUDE_PATHS' => core_headers } s.frameworks = 'DeviceCheck', 'CryptoKit', 'Security' end -
Name the three pods in your app's target in
ios/Podfile. The paths are relative to theiosfolder: -
Install the pods:
The package's pod requires an iOS deployment target of 15.1 or later. It asks for DeaSDK at the
exact version of @dea/react-native, so the podspecs must name that version.
Android setup¶
The Android bridge depends on ai.dea:dea-sdk at the same version as @dea/react-native. Gradle
resolves a library's dependencies from your app's repositories, so add DEA's Maven repository for
the release at the end of android/build.gradle:
// android/build.gradle
allprojects {
repositories {
maven {
url = uri("https://sdk.dep-protocol.com/0.26.0/android")
content { includeGroup("ai.dea") }
}
}
}
The repository URL names the release, and each release's repository serves that release only. Keep
it at the version of @dea/react-native. The content filter makes Gradle ask DEA's repository for
DEA's packages only.
The native Android SDK declares the INTERNET permission, which Android's manifest merger adds to
your app.
Initialize the SDK¶
Initialize once, as early as possible — at the top level of your entry file or in your root component's first effect — so that capture covers the whole session.
import {useEffect} from 'react';
import * as Dea from '@dea/react-native';
import {Root} from './Root';
export default function App() {
useEffect(() => {
Dea.init({appId: 'YOUR_APP_ID'}).then(started => {
if (!started.ready) {
console.warn('DEA cannot score:', started.coreFault);
}
});
}, []);
return <Root />;
}
- Every call returns a promise, including the cheap ones. Await them when the order matters.
initis safe to call more than once. A repeat call returns the running session and keeps its options.initdoes not fail when the core cannot start. The SDK keeps capturing,started.readyisfalse, andstarted.coreFaultsays why.- With
automationDetection: true, the first sure sign that automation drives the app stops the SDK at once, on every account and build: nothing is captured, scored, signed or registered, and the classification staysinsufficient. The stop lasts untilreset()or a new start (the app launched again, ordispose()theninit), andstopped()resolves an object while it holds. A rooted Android device or a jailbroken iPhone stops the SDK too, except on a test build. See Automation detection and Rooted and jailbroken devices. - Capture is global: every touch in the app, the motion sensors, and the app lifecycle. There is no component to wrap your app in and nothing to register per screen.
- Every other call except
deaTarget,getTargetTallyandonAttestationEventrejects untilinithas run. - Nothing is recorded until the user consents. See the next step.
Note: Pass
appKeytoinitas well — the key of the platform the build is for. Reading the classification does not need it: scoring runs on the device. Without it, with a productionappId,attest()resolvesunsupportedwithout contacting DEA. See Accounts and keys for what the key is for.
Ask for consent¶
By default the SDK records nothing until the user agrees. This step is required: an app that never asks collects no data and never gets a classification.
The React Native SDK has no built-in consent dialog. Ask with your own UI, then record the answer:
import {Alert} from 'react-native';
import * as Dea from '@dea/react-native';
export async function askForConsent(): Promise<void> {
if ((await Dea.getConsent()) !== 'unknown') return; // already answered
Alert.alert(
'Help us keep bots out',
'We measure how you touch and hold your phone to tell people apart from bots. We never record what you type or what is on your screen.',
[
{text: 'Not now', style: 'cancel', onPress: () => Dea.setConsent(false)},
{text: 'Allow', onPress: () => Dea.setConsent(true)},
],
);
}
The answer is stored on the device, so the question only needs to be asked once. If you already
asked before init, pass the answer to init instead — see
User Consent. What the SDK captures, and what it never
reads, is on Privacy and network.
Use the classification¶
Read the classification at the moment you make a decision. The read is fast and local: it does not call the network.
import * as Dea from '@dea/react-native';
async function onSignUp(form: SignUpForm) {
const {result} = await Dea.getClassification();
if (result === 'human') {
await submitSignUp(form);
} else {
showChallenge(); // 'bot', 'undetermined' or 'insufficient': a captcha, a delay, a manual review
}
}
The thresholds come from the loaded model, never from your app.
insufficient and undetermined are answers in their own right, and your app decides what each
allows. insufficient means the session is not
sufficient yet, because it has fewer
actions than the model asks for (8 with the built-in model, see
Evidence); value is null then. undetermined
means the score is between the two thresholds. See
How scoring works.
Verify your setup¶
- Check the SDK from code after
init:
const started = await Dea.init({appId: 'YOUR_APP_ID'});
console.log('ready:', started.ready); // true
console.log('fault:', started.coreFault); // null
console.log('sdk:', started.sdkVersion);
const info = await Dea.getSessionInfo();
console.log('session:', info.session); // a UUID
- Grant consent, use the app — tap, scroll, swipe — for at least 8 actions, then read the classification:
console.log(await Dea.getConsent()); // 'granted'
console.log(await Dea.getClassification());
// { result, value, actions, botThreshold, humanThreshold, modelVersion }
result leaves 'insufficient' once actions reaches the number the model asks for: 8 with the
built-in model.
- On Android with an SDK build of the
testchannel, you can also turn ondebugand watch Logcat. The SDK you ship prints nothing:
You should see one [dea] … line per captured event after consent is granted. If you see
nothing after touching the screen, see Troubleshooting.
Turn debug off before you ship.
Before you release¶
- [ ]
debugisfalse - [ ] Your consent flow calls
setConsent, or passesconsenttoinit— see User Consent - [ ] The classification is read at the decision point, with a fallback for
bot,undeterminedandinsufficient— see Human Scoring - [ ] Your main controls are named with
deaTarget— see Name your views - [ ] Capture is paused on password and payment screens — see Sensitive Screens
- [ ]
reset()is called on logout — see Sessions - [ ] Your privacy policy covers what the SDK captures and sends — see Privacy and network and Going to production
Next steps¶
- User Consent — ask before anything is recorded
- Human Scoring — read the classification, and name your views
- Sensitive Screens — pause capture on password and payment screens
- Sessions — start a new session on logout
- Options — every option
initaccepts - How scoring works — sessions, evidence, the model and its thresholds
- Accounts and keys — the
appIdandappKeyDEA issues - Troubleshooting