@face-auth/face-id

Face Auth SDK for browser-oriented facial authentication and wizard flows. Current package version: 0.1.6.

Installation

npm install @face-auth/face-id

License

Proprietary runtime-only license. You may execute unmodified copies of the package, but modification, redistribution, sublicensing, and other reuse are not permitted. See LICENSE.

Support

• Homepage: https://www.face-auth.me/
• Support: [email protected]

Package format

• import resolves to the package ESM bundle.
• require resolves to the package CommonJS bundle.
• Deep imports are not part of the supported public contract; consume the package root entrypoint only.

Public API

Classes

• FaceId
• FaceWizard

Runtime enums

• ErrorCode
• FrameRate
• WizardReason
• DecisionStatusType

Exported types

• Either<T>
• FaceError
• AuthorizeResponse
• RegisterResponse
• IdentifyResponse
• UnregisterResponse
• FaceFile
• AddDataResponse
• StartWizardResponseDto
• WizardHandlers
• DecisionParams
• WizardErrorParams
• StopFrameParams
• PlaybackToggleParams
• FrameRates
• SetFrameRateParams
• FrameRateChangedParams

FaceId

Creates an authenticated SDK client for face registration and matching.

import { FaceId } from '@face-auth/face-id';

const faceId = new FaceId('4demo.face-auth.me', 'client-token');

Methods

• register(faceId: string, image: Blob, imageType: string): Promise<Either<RegisterResponse>>
• identify(image: Blob, imageType: string): Promise<Either<IdentifyResponse>>
• unregister(faceId: string): Promise<Either<UnregisterResponse>>

Example:

const canvas = document.getElementById('canvas') as HTMLCanvasElement;

canvas.toBlob(async blob => {
  if (!blob) return;

  const response = await faceId.register('face_id_123', blob, 'image/png');
  console.log(response.success);
}, 'image/png');

FaceWizard

Starts and feeds Face Auth wizard sessions.

import { FaceWizard } from '@face-auth/face-id';

const wizard = new FaceWizard('4demo.face-auth.me', 'client-token');

Methods

• start(handlers: WizardHandlers): Promise<Either<StartWizardResponseDto>>
• addData(wizardId: number, files: FaceFile[]): Promise<Either<AddDataResponse[]>>

Handler callbacks

• onConnected
• onDisconnected
• onProgress
• onDecision
• onStop
• onError
• onPlaybackToggle
• onSetFrameRate
• onFrameRateChanged

Browser expectations

• Browser-oriented runtime.
• Requires fetch, FormData, Blob, File, and websocket support in the host environment.
• Use your Face Auth domain and client token issued by the platform.