Skip to content

Installation

Install the SDK package for your platform. All packages are published to npm under the @moveris scope.

In plain terms

Run the install command for your platform (React web, React Native). For React, you need @moveris/react and @moveris/shared. For React Native, add @moveris/react-native instead. Optional: install @mediapipe/tasks-vision for client-side face detection.

React (Web)

npm install @moveris/react @moveris/shared

Or with other package managers:

pnpm add @moveris/react @moveris/shared

yarn add @moveris/react @moveris/shared

Peer Dependencies

Package Required Version
react >= 18.0.0
react-dom >= 18.0.0

Optional Dependencies

For client-side face detection (used by useFaceDetection and useSmartFrameCapture):

npm install @mediapipe/tasks-vision

React Native

npm install @moveris/react-native @moveris/shared

Peer Dependencies

Package Required Version
react >= 18.0.0
react-native >= 0.83.1
react-native-vision-camera ^4.0.0
react-native-reanimated ^3.15.0

Install the peer dependencies:

npm install react-native-vision-camera react-native-reanimated

For iOS, install native pods:

cd ios && pod install

Platform Configuration

iOS (Info.plist)

<key>NSCameraUsageDescription</key>
<string>We need camera access to verify your identity</string>

Android (AndroidManifest.xml)

<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="true" />
<uses-feature android:name="android.hardware.camera.front" android:required="true" />

Shared (Core Only)

If you only need the API client and types without UI components (e.g., for a Node.js backend or custom UI):

npm install @moveris/shared

@moveris/shared has zero runtime dependencies and works in any JavaScript/TypeScript environment.

Version Compatibility

Core SDK packages should be kept on compatible versions:

@moveris/shared

4.1.2

@moveris/react

4.1.3

@moveris/react-native

4.1.2

Version Matching

Install the versions above together: @moveris/shared 4.1.2, @moveris/react 4.1.3, and @moveris/react-native 4.1.2. Stay on the 4.1 line. 4.0.0 is a breaking change: only Mixed V3.1.1 aliases compile, and the default capture is 30 frames. See the Changelog.

Verifying Installation

After installing, verify the SDK is working:

import { LivenessClient } from '@moveris/shared';

const client = new LivenessClient({
  apiKey: 'sk-your-api-key',
  baseUrl: 'https://api.moveris.com',
});

// Check API health
const health = await client.health();
console.log('API status:', health);

Next Steps