Client Library (Reference)
In-repo TypeScript fetch wrapper over the Biometric API. Not a published/distributed SDK.
Live Engine
Reference client — copy it from the docs page; it is not published to a package registry yet.
Engine
src/lib/veridexa-biometric-sdk
A minimal, in-repo TypeScript wrapper around the public Biometric API (browser + Node 18+, zero deps). It base64-encodes bytes, fills the request envelope, and returns typed responses. It is a reference client — not a versioned, published or distributed SDK: no npm package, no retry/back-off, no auth refresh, no pagination, no error taxonomy beyond raw envelope fields.
Available methods
enroll({ runId, sample })compare({ runId, probe, reference })liveness({ runId, sample })— not enabled yetlistDevices()bytesToBase64/base64ToByteshelpers
Module
src/lib/veridexa-biometric-sdk/index.ts
Exports:
createVeridexaBiometricSdk({ baseUrl, apiKey, fetchImpl? })
bytesToBase64, base64ToBytesExample — enrol and compare
import { createVeridexaBiometricSdk } from "@/lib/veridexa-biometric-sdk";
const sdk = createVeridexaBiometricSdk({
baseUrl: "https://veridexa.io",
apiKey: process.env.VERIDEXA_API_KEY!,
});
const enrol = await sdk.enroll({
runId: "run-1",
sample: { modality: "face", format: "image/png", bytes },
});
const cmp = await sdk.compare({
runId: "run-1",
probe: { modality: "face", format: "image/png", bytes: probeBytes },
reference: { modality: "face", format: "image/png", bytes: refBytes },
});
console.log(cmp.result?.outcome, cmp.result?.score?.value);