identity-verification-feature-identity-verification

This library was generated with Nx.

Public API highlights

isSupported() — pre-flight environment check

Synchronous binary check that the current browser/device falls within the SDK's supported range. Call it before initializing AuthmeIdentityVerification so unsupported users hit a friendly "this device is not supported" page instead of an opaque error mid-flow.

import { isSupported } from '@authme/identity-verification';

const check = isSupported();
if (!check.supported) {
  // Show "please use another browser/device". Log `reasons` to telemetry.
  console.warn('eKYC unsupported:', check.reasons, check.info);
  return;
}
// supported === true → continue with SDK initialization

The returned object:

| Field | Meaning | | ----------- | ------------------------------------------------------------------------- | | supported | true iff reasons is empty. | | reasons | Why the device is unsupported. One or more of: NO_WEBASSEMBLY, NO_MEDIA_DEVICES, INSECURE_CONTEXT, OLD_IOS (iOS < 16.4), OLD_ANDROID (Android < 9), IN_APP_WEBVIEW (LINE / FB / IG / Messenger / WeChat). Empty when supported is true. | | info | Detected environment snapshot — device string, system string, WASM flags, mediaDevices, secureContext, in-app WebView, hardwareConcurrency, deviceMemory. Useful for telemetry regardless of supported. |

The check is purely UA + feature detection: it does not request the camera, load the engine, or make network requests. Typical execution time is sub-millisecond. See docs/browser-support-matrix.md for the corresponding human-readable support matrix.

Running unit tests

Run nx test identity-verification-feature-identity-verification to execute the unit tests via Jest.