Skip to content
guru-murtthy
BharatKYC
Public

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

🇮🇳 BharatKYC

Zero-Knowledge Identity Platform for India

Prove who you are. Never reveal what you are.

License: MIT TypeScript React DPDP Compliant Polygon zkEVM

⚡ What is BharatKYC?

Today, every time you do KYC — at a bank, a broker, a hospital — you hand over your full Aadhaar, PAN, and income data. The institution stores it. It gets hacked. It gets sold. You have zero control.

BharatKYC flips this. Using Zero-Knowledge Proofs, a citizen can prove "I am above 18 and earn over ₹10 lakh" — without revealing their birth date or salary. The institution gets a cryptographic yes/no. Your data never leaves your device.

Built on India Stack — Aadhaar, Account Aggregator, DigiLocker, eSign — making it legally valid under DPDP Act 2023 and deployable on Polygon zkEVM.

🔥 The Problem

Old KYC BharatKYC
Share everything (Aadhaar, PAN, salary) Share only what's needed via ZK proof
Institution permanently stores your data Institution gets a cryptographic receipt only
No revocation mechanism On-chain consent revocation (ERC-5484 SBT burn)
No audit trail Regulator sees full immutable consent ledger
Legally grey on DPDP Fully DPDP Act 2023 compliant with eSign

🏗️ System Architecture

┌─────────────────────────────────────────────────────────────────────┐
│                         CITIZEN'S DEVICE                            │
│                                                                     │
│   Aadhaar XML  ──►  India Stack Parser  ──►  ZK Circuit (WASM)     │
│                                                  │                  │
│   Biometric Liveness (FIDO2 WebAuthn)            ▼                  │
│                                         Groth16 ZK Proof           │
│                                         (No raw data leaves)       │
└─────────────────────────────────────────┼───────────────────────────┘
                                          │
                                          ▼
┌─────────────────────────────────────────────────────────────────────┐
│                          BACKEND API (tRPC)                         │
│                                                                     │
│   Proof Verification  ──►  W3C Verifiable Credential Issuance      │
│                       ──►  DPDP eSign Consent Receipt              │
│                       ──►  Consent Audit Log (PostgreSQL)          │
│                       ──►  DID Registration (Polygon zkEVM)        │
└───────────────┬─────────────────────────────────────────────────────┘
                │
        ┌───────┴───────┐
        ▼               ▼
┌──────────────┐  ┌──────────────────────────────┐
│   VERIFIER   │  │       REGULATOR              │
│   PORTAL     │  │       DASHBOARD              │
│              │  │                              │
│ Set KYC      │  │  View all consent logs       │
│ requirements │  │  Audit proof submissions     │
│ Generate QR  │  │  Monitor revocations         │
│ Poll status  │  │  DPDP compliance reports     │
└──────────────┘  └──────────────────────────────┘

📦 Repository Structure

bharatkyc/
├── apps/
│   ├── citizen-app/         # 🪪 Citizen ZK Wallet UI       (port 3000)
│   ├── landing/             # 🌐 Product Landing Page        (port 3002)
│   ├── verifier-portal/     # 🏦 Institution Verifier UI     (port 3003)
│   └── regulator-dashboard/ # 🏛️ Regulatory Audit Console   (port 3004)
│
├── packages/
│   ├── zk-core/             # 🔐 Circom circuits + SnarkJS engine
│   ├── india-stack/         # 🇮🇳 Aadhaar, AA, DigiLocker, eSign, ABHA
│   ├── chain/               # ⛓️ Polygon DID + Verifiable Credentials
│   ├── biometrics/          # 🤳 FIDO2 WebAuthn + liveness detection
│   ├── risk-engine/         # 📊 AML/OFAC risk scoring engine
│   └── sdk/                 # 🧰 Public React SDK for integrators
│
├── backend/                 # 🟢 tRPC + Express + Prisma API server
│   ├── src/
│   │   ├── server.ts        # Express + CORS setup
│   │   ├── router.ts        # All tRPC procedures
│   │   └── db.ts            # Prisma ORM + in-memory fallback
│   └── prisma/
│       └── schema.prisma    # DB schema: Users, Sessions, ConsentLogs
│
├── docker-compose.yml       # PostgreSQL + Redis containers
├── package.json             # NPM Workspaces monorepo root
└── README.md

🔐 ZK Circuits

All circuits are located in packages/zk-core/circuits/ and compiled with Circom v2.1.8. Proofs use the Groth16 proving system (~200 byte proof size, constant verification time).

Circuit What it proves
age_proof.circom "I am above age X" — without revealing birth date
income_range.circom "My income is between ₹A and ₹B" — without revealing salary
sanctions_clear.circom "My name hash is NOT on the OFAC/AML blocked list"
credit_band.circom "My credit score is above Y" — without revealing the score
profession_verify.circom "I work in profession code Z"
nationality_proof.circom "I am an Indian national"
composite_kyc.circom Master circuit combining all checks — 230 constraints

The master circuit enforces all checks at the cryptographic level:

isCompositeValid <== temp4 * isNationalityValid;
isCompositeValid === 1;  // The circuit FAILS if ANY check fails

🇮🇳 India Stack Integration (@bharatkyc/india-stack)

Module Description
aadhaar.ts Parses Aadhaar Offline XML (from UIDAI portal) — extracts DOB/income fields as private ZK inputs, never sent to server
esign.ts Issues DPDP-compliant digital consent receipts using eSign-SHA256 (legally valid under IT Act 2000)
aa.ts Account Aggregator integration — pulls bank statement data for the income ZK proof
digilocker.ts DigiLocker document verification for education/profession credentials
abha.ts Ayushman Bharat Health Account integration for health KYC

🗺️ Application Flows

Citizen Wallet (localhost:3000)

  1. Credentials Wallet — Upload Aadhaar Offline XML → parsed locally → ZK proof generated in-browser
  2. Biometric Liveness — Face mesh + blink/head-turn detection → FIDO2 WebAuthn passkey registration
  3. Scan KYC Request — Paste verifier's JSON config → generate ZK proof → submit to backend
  4. Consent & Revocation — View all active consents → one-click revoke (triggers on-chain SBT burn)

Verifier Portal (localhost:3003)

  1. Set KYC requirements (age threshold, income range, sanctions check)
  2. Generate a verification session QR code
  3. Share QR/JSON with citizen
  4. Poll for proof submission status in real-time

Regulator Dashboard (localhost:3004)

  1. View aggregate statistics (total proofs, active consents, revocations)
  2. Browse full audit log of all consent events
  3. Monitor DPDP compliance across the platform

🛠️ Tech Stack

Layer Technology Why
ZK Circuits Circom + SnarkJS Groth16 proofs — tiny size, constant verification
Frontend React 18 + Vite + TypeScript Fast HMR, proper WASM support for SnarkJS
Backend API Node.js + Express + tRPC Type-safe end-to-end, no REST swagger needed
Database PostgreSQL + Prisma Structured consent audit queries
Session Cache Redis Fast verification session polling
Blockchain Polygon zkEVM EVM-compatible + ZK-native, low gas fees
Identity W3C DID + Verifiable Credentials Open standard, interoperable
Auth FIDO2 WebAuthn Phishing-resistant passkey binding
Compliance DPDP Act 2023 + eSign (IT Act 2000) Legally valid in India

🚀 Getting Started

Prerequisites

  • Node.js v18+
  • npm v10+
  • Docker & Docker Compose (for PostgreSQL + Redis)

1. Clone the Repository

git clone https://github.com/guru-murtthy/BharatKYC.git
cd BharatKYC

2. Install Dependencies

npm install

3. Configure Environment

Create backend/.env from the example:

cp backend/.env.example backend/.env

Edit the values:

DATABASE_URL="postgresql://postgres:password@localhost:5432/bharatkyc"
REDIS_URL="redis://localhost:6379"
PORT=3001
NODE_ENV=development

Note: If DATABASE_URL is not set, the backend automatically uses an in-memory store — perfect for offline demos!

4. Start Infrastructure (Optional)

docker-compose up -d

5. Run the Full Platform

# Start all apps and the backend simultaneously
npm run dev

This starts:

Service URL
Citizen Wallet http://localhost:3000
Backend API http://localhost:3001
Landing Page http://localhost:3002
Verifier Portal http://localhost:3003
Regulator Dashboard http://localhost:3004

Run Individual Apps

npm run dev:backend    # Backend API only
npm run dev:citizen    # Citizen Wallet only
npm run dev:verifier   # Verifier Portal only
npm run dev:regulator  # Regulator Dashboard only
npm run dev:landing    # Landing Page only

🧩 ZK Circuit Setup (Optional — pre-compiled)

The ZK circuit build outputs are pre-compiled. To rebuild from scratch:

# Requires Circom v2.1.8 (auto-downloaded)
npm run build:circuits --workspace=packages/zk-core

This runs the full setup:

  1. Downloads circom binary
  2. Compiles composite_kyc.circom → R1CS + WASM
  3. Runs local Powers of Tau ceremony (pot12_final.ptau)
  4. Generates Groth16 proving/verification keys (.zkey)
  5. Exports Solidity verifier contract

🔗 API Reference (tRPC Procedures)

Procedure Type Description
createSession Mutation Verifier creates a KYC verification request
submitZKProof Mutation Citizen submits proof + public signals for verification
getSessionStatus Query Poll a session's current status
getConsentLogs Query Fetch a citizen's full consent audit trail
revokeConsent Mutation Revoke a consent + burn ERC-5484 SBT
getRegulatorStats Query Aggregate metrics for the regulator dashboard

🏛️ DPDP Act 2023 Compliance

BharatKYC is designed ground-up for India's Digital Personal Data Protection Act 2023:

  • Right to Consent — Every data share is tied to an eSign-authenticated consent receipt
  • Right to Revocation — Citizens can revoke any consent from their wallet, triggering on-chain SBT burn
  • Data Minimisation — ZK proofs ensure only boolean outcomes are shared, never raw personal data
  • Audit Trail — Full immutable consent log accessible to CERT-In and sector regulators
  • Purpose Limitation — Each verification session specifies the exact purpose; stored on-chain

🗂️ Smart Contracts

Contract Location Description
BharatKYCRegistry.sol packages/chain/contracts/ ERC-5484 Soulbound Token registry for KYC credentials on Polygon zkEVM

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/your-feature
  3. Commit your changes: git commit -m 'Add your feature'
  4. Push to the branch: git push origin feature/your-feature
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.

🙏 Acknowledgements

  • iden3/circom — ZK circuit compiler
  • iden3/snarkjs — JavaScript ZK proof library
  • UIDAI — Aadhaar Offline XML specification
  • ReBIT — Account Aggregator ecosystem
  • Polygon — zkEVM infrastructure
  • Ministry of Electronics & IT — DPDP Act 2023

Built with ❤️ for Bharat 🇮🇳

BharatKYC Protocol · DPDP Act 2023 · India Stack Ecosystem

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages