@realeyes/verifeye-sdk

React component library for embedding the VerifEye identity-verification flow into your web application.

Overview

@realeyes/verifeye-sdk lets you embed the VerifEye verification flow directly into your web application. Its single entry point is the VerifyVerifier React component, which renders the full client-side experience — camera access, consent, liveness, and image capture — against a verification session you create server-side.

The SDK handles the browser-side capture and the calls to the VerifEye Service. It does not create sessions or expose results on its own:

• Your backend creates a verification session (using your API key) and returns its sessionId and accessToken to the browser.
• The VerifyVerifier component runs the verification using those credentials and invokes onVerificationCompleted when the flow finishes.
• Your backend fetches the outcome from the VerifEye Service once the flow completes.

Security: session creation requires your API key and must happen server-side only. Never ship your API key to the browser — the SDK only ever receives a short-lived session accessToken.

Requirements

• A VerifEye account and API key — sign up at the VerifEye Developer Console
• A server-side endpoint that creates a verification session and returns its sessionId and accessToken
• A secure context (HTTPS) — browsers only grant camera access over HTTPS or localhost
• An ESM-only toolchain — the package ships ES modules only (no CommonJS require), so consume it from an ESM project or a modern bundler (Vite, webpack 5, Next.js, etc.)

Installation

npm install @realeyes/verifeye-sdk

Localization

The SDK's built-in UI text — dialog titles, buttons, hints, etc. — is driven by a locale file and can be translated or overridden per key.

<VerifyVerifier
    // ...session props
    lang="en"
    langOverrides={{
        consent_title: "One quick check",
        consent_continue_button: "Continue",
    }}
/>

• lang — language tag, defaults to "en". Case-insensitive, and _ is accepted for -. An unsupported value logs a warning and falls back to "en" rather than throwing.
• langOverrides — a flat map of per-key replacements applied on top of lang. Only the keys you pass are replaced. The VerifyTextKey type is exported, so keys autocomplete and typos fail to compile.

Supported languages

en bg cs da de el es et fi fr hu id it ja ko lt lv nb nl pl pt-BR pt-PT ro ru sk sl sv tr uk zh-Hans zh-Hant

Also exported as SUPPORTED_LANGUAGES. Tags resolve in this order: exact match, then a known alias, then the base language. So "de-AT" → de, "zh-TW" → zh-Hant, "zh-CN" → zh-Hans, "pt" → pt-PT, "no" → nb. Portuguese and Chinese are shipped only as variants — a bare "pt" or "zh" resolves to the alias above rather than failing.

Some strings carry a small markup subset so a whole sentence stays translatable as one unit: <b>…</b> for emphasis, <br/> for a line break, and {name} slots (e.g. {privacyPolicy} in the consent notice, {seconds} in the timeout countdown). Anything else is rendered as literal text — override values are never interpreted as HTML.

Keys prefixed liveness_ translate the liveness check UI shown during the liveness step.

Privacy & data handling

This SDK captures camera images and processes facial/biometric data to perform verification. When integrating it, you are responsible for obtaining appropriate user consent and complying with applicable privacy and biometric-data regulations in your jurisdiction. See the Realeyes Privacy Policy.

Documentation

• Web SDK guide & API reference: https://verifeye-docs.realeyes.ai/cloud-apis-web-sdks/web-sdk/
• VerifEye documentation: https://verifeye-docs.realeyes.ai/
• Developer Console: https://verifeye-console.realeyes.ai/

License

Copyright © 2026 Realeyes OÜ. Licensed under the Apache License 2.0; see the LICENSE and NOTICE files included in the package. Use of the hosted VerifEye service is additionally governed by the Realeyes Terms.