Skip to content
  • react native
  • getting started
  • prerequisites

Prerequisites

React Native Requirements

Section titled “React Native Requirements”
  • React Native >= 0.70
  • Node.js >= 18
  • TypeScript is recommended, but the SDK also works from plain JavaScript

Both architectures are supported

Section titled “Both architectures are supported”

The SDK works on the legacy bridge and on the New Architecture, which has been the default since React Native 0.76. You do not need to set newArchEnabled either way.

This is worth stating because the two deliver native events differently, and a listener is the one place where a mismatch is silent rather than loud: addSecurityListener returns a live-looking subscription whose remove() works, the scan still runs, and the backend and the dashboard both report the threat, while your own JavaScript callback never fires. The pull API (performScan, getAllRiskFactors) is unaffected, so an integration checked only through those looks correct.

If a listener stays silent on a New Architecture build while the dashboard shows the event, update the SDK before looking anywhere else.

Android Requirements

Section titled “Android Requirements”
  • Minimum SDK: API Level 26
  • Target SDK: API Level 35 recommended
  • Java/Kotlin Android project

iOS Requirements

Section titled “iOS Requirements”
  • iOS 15.0 or later
  • Xcode 15.0 or later
  • CocoaPods installed

Alphyn Portal Requirements

Section titled “Alphyn Portal Requirements”

A React Native project ships two platform builds, and an app registration on the Alphyn Portal is per platform. Before integrating, register two apps on portal.byterialab.com:

  • an Android app registered with your Android package name (the applicationId)
  • an iOS app registered with your iOS bundle identifier

Each app has its own API key: Android builds register with the Android app’s key, and iOS archives register with the iOS app’s key. See How to Register Your App for the step-by-step portal flow.