Client SDK

npm install @facegate/client

import { FaceGateClient } from '@facegate/client';
 
const fg = new FaceGateClient({
  apiKey: 'fg_test_your_key_here',
});

const result = await fg.match({ image: frame.imageData });
// result.matched    — boolean
// result.confidence — 0–100
// result.user       — MatchedUser | null

const session = await fg.createLivenessSession();
// hand session.session_id / credentials / region to the AWS liveness UI

const result = await fg.verify({ livenessSessionId: session.session_id });
// result.matched               — boolean
// result.confidence            — 0–100
// result.verification_token    — string | null  (use with createSession)
// result.user                  — MatchedUser | null
// result.risk                  — RiskAssessment
// result.re_enrollment_required — boolean

const fgSession = await fg.createSession(result.verification_token!);
// fgSession.token            — signed JWT
// fgSession.refresh_token    — string
// fgSession.expires_in       — seconds
// fgSession.user             — MatchedUser
// fgSession.provider_session — provider tokens | null

const enrolled = await fg.enroll({
  livenessSessionId: session.session_id,
  name: 'Ada Lovelace',
  role: 'admin',
});
// enrolled.user_id     — string
// enrolled.enrollments — { faceId, angle, confidence }[]

const status = await fg.health();
// status.status         — 'healthy' | 'degraded' | 'unhealthy'
// status.version, status.provider, status.uptime_seconds

const off = fg.on((event) => {
  if (event.type === 'verified') console.log('confidence', event.data.confidence);
});
// later: off();

import { Camera } from '@facegate/client';

const camera = new Camera();
await camera.open();                 // permission + stream
camera.attachToVideo(videoElement);  // <video> in your DOM
const frame = camera.captureFrame(); // CapturedFrame
camera.close();                      // release

import { FaceGateClient, Camera, CameraPermissionDenied } from '@facegate/client';
 
const fg = new FaceGateClient({ apiKey: 'fg_test_your_key_here' });
 
async function signIn(videoEl: HTMLVideoElement) {
  const camera = new Camera();
 
  try {
    // 1. Open the camera and render it
    await camera.open();
    camera.attachToVideo(videoEl);
 
    // 2. Wait for the video to be ready, then capture a frame
    await new Promise<void>((resolve) => {
      if (camera.isReady) return resolve();
      videoEl.onloadeddata = () => resolve();
    });
    const frame = camera.captureFrame();
 
    // 3. Match the face
    const result = await fg.match({ image: frame.imageData });
 
    if (!result.matched || result.confidence < 95) {
      console.log('Not recognized');
      return null;
    }
 
    // 4. Handle the matched user
    console.log('Welcome back,', result.user?.name);
    return result.user;
  } catch (err) {
    if (err instanceof CameraPermissionDenied) {
      console.error('Camera permission was denied');
    } else {
      console.error('Sign-in failed', err);
    }
    return null;
  } finally {
    camera.close();
  }
}

// 1. Start an AWS liveness session
const session = await fg.createLivenessSession();
 
// 2. Run the AWS FaceLivenessDetector component with session.credentials / region.
//    When it completes successfully, you have session.session_id.
 
// 3. Verify the result
const result = await fg.verify({ livenessSessionId: session.session_id });
if (!result.matched) throw new Error('Face not recognized');
 
// 4. Exchange the token for a session
const fgSession = await fg.createSession(result.verification_token!);
console.log('JWT:', fgSession.token);