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)¶
Or with other package managers:
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):
React Native¶
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:
For iOS, install native pods:
Platform Configuration¶
iOS (Info.plist)¶
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):
@moveris/shared has zero runtime dependencies and works in any JavaScript/TypeScript environment.
Version Compatibility¶
All three packages are versioned together to ensure compatibility:
| @moveris/shared | @moveris/react | @moveris/react-native |
|---|---|---|
| 3.4.0 | 3.4.0 | 3.4.0 |
Version Matching
Always use the same major version across all @moveris packages. Mixing major versions may cause type mismatches or runtime errors.
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¶
- React Quick Start -- Build your first liveness check with React
- React Native Quick Start -- Get started with React Native
- LivenessClient Reference -- Explore the full API client