Tediwave Biometric Verifier (Headless SDK)

This SDK provides headless biometric verification capabilities for React Native apps. It focuses on processing, liveness and optional identity verification, and session management — without imposing any UI. Your application is responsible for rendering camera views, overlays, instructions, progress bars, and retry flows.

Key responsibilities:

• Camera processing (frame processor to wire into your camera)
• Face detection and face quality metrics
• Challenge generation and validation
• Liveness verification
• Optional identity verification (when a reference image is provided)
• Anti-spoofing checks
• Voice guidance (configurable)
• Session management and result payloads

Installation

npm install react-native-tediwave-biometric-verifier

Quick Start (headless)

import React from 'react';
import { Camera, useCameraDevice, useCameraFormat } from 'react-native-vision-camera';
import {
  BiometricCamera,
  useBiometricEngine,
} from 'react-native-tediwave-biometric-verifier';

export default function MyVerifierScreen() {
  const device = useCameraDevice('front');
  const format = useCameraFormat(device, [
    { videoResolution: { width: 480, height: 480 } },
    { fps: 30 },
  ]);
  const {
    frameProcessor,
    frameProcessorFps,
    status,
    verificationStatus,
    currentChallenge,
    progress,
    startVerification,
    pauseVerification,
    resumeVerification,
    finishVerification,
    faceQuality,
    completedChallenges,
    totalChallenges,
    setLiveImage,
    onResult,
  } = useBiometricEngine({ apiKey: 'MY_KEY', autoStart: false });

  React.useEffect(() => {
    startVerification();
  }, [startVerification]);

  return (
    <BiometricCamera
      device={device}
      format={format}
      isActive
      frameProcessor={frameProcessor}
      frameProcessorFps={frameProcessorFps ?? 1}
      style={{ flex: 1 }}
    >
      {/* Render your custom UI overlays here using the headless state above */}
    </BiometricCamera>
  );
}

Primary exports

• useBiometricEngine(config): Headless hook returning state, control methods, frameProcessor and results.
• BiometricCamera: Lightweight camera wrapper that forwards props to react-native-vision-camera and accepts a frameProcessor.
• useCameraFormat: Recommended to request a low-resolution native capture size for AI/biometric models instead of resizing frames in a separate plugin.

Documentation

• See the example/ folder for full integration examples demonstrating custom UIs, retries and identity mode.

Migration notes

• The SDK removed built-in UI components. Move any in-app UI into your application and consume the headless hook and camera component to drive UI state.
• The legacy vision-camera-resize-plugin path has been removed. The SDK now forwards the native Frame object directly to your biometric/native layer and uses useCameraFormat for optional low-resolution capture.

License

MIT