@zeehdev/zeeh-kyc-react-sdk

Embeddable React components for Zeeh identity verification: full KYC onboarding, face liveness, document upload, and server-side checks—without wiring dozens of API endpoints yourself.

Installation

npm i @zeehdev/zeeh-kyc-react-sdk

Peer dependencies (install in your app):

npm install react react-dom zustand framer-motion axios zod

Quick start

Import the stylesheet once at your app entry, then mount the widget:

import { KycWidget } from "@zeehdev/zeeh-kyc-react-sdk";
import "@zeehdev/zeeh-kyc-react-sdk/style.css";

export function VerifyPage() {
  return (
    <KycWidget
      businessId="YOUR_BUSINESS_ID"
      environment="sandbox"
      onComplete={({ sessionId }) => console.log("Done", sessionId)}
      onError={(message) => console.error(message)}
    />
  );
}

Features

• <KycWidget /> — complete KYC flow (email OTP, NIN/BVN, documents, liveness, automated verification)
• <IdentityVerification /> — session-based ID + liveness for merchant links
• createZeehClient — typed HTTP client with injectable auth
• Pre-built styles — @zeehdev/zeeh-kyc-react-sdk/style.css
• Mobile-ready — responsive UI; works in mobile browsers and native WebViews

Requirements

• React 18 or 19
• HTTPS in production (camera / liveness)
• Zeeh business ID and CORS allowlist for your domain

Package exports

import { KycWidget } from "@zeehdev/zeeh-kyc-react-sdk";
import { IdentityVerification } from "@zeehdev/zeeh-kyc-react-sdk";
import { createZeehClient } from "@zeehdev/zeeh-kyc-react-sdk";
import "@zeehdev/zeeh-kyc-react-sdk/style.css";

Environments

| environment | Use case | |---------------|----------| | sandbox | Development / UAT | | production | Live users | | auto | Infer from hostname (localhost → sandbox) |

Documentation

| Guide | Description | |-------|-------------| | Getting started | First integration, environments, callbacks | | Installation | npm, local path, GitHub alternatives | | Introduction | Overview, architecture, integration patterns | | Components | Props, callbacks, step reference | | Mobile & native apps | WebView, deep links, end-user flow | | Hosting & CORS | Deploy, HTTPS, CORS | | API client | createZeehClient reference | | Troubleshooting | Styling, CORS, camera, verification |

Mobile apps

This is a web SDK. Native iOS/Android apps should load a hosted HTTPS page that renders KycWidget inside a WebView. See Mobile integration.

Development (this repo)

npm install
npm run dev          # playground at http://localhost:5174
npm run build        # dist/index.js + dist/style.css + types

Playground: http://localhost:5174/?businessId=YOUR_BUSINESS_ID

Publishing (maintainers)

npm run build
npm publish --access public

Support

[email protected] — include business ID, environment, device/browser, and failing step when reporting issues.