@realeyes/verifeye-sdk
v1.1.2
Published
React component library for embedding the VerifEye identity-verification flow into your web application.
Readme
@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
sessionIdandaccessTokento the browser. - The
VerifyVerifiercomponent runs the verification using those credentials and invokesonVerificationCompletedwhen 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
sessionIdandaccessToken - 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-sdkPrivacy & 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.
