ZKProva Documentation

Welcome to the documentation for ZKProva — a ZKP-powered portable identity system for credit union members.

ZKProva enables credit union members to prove membership and selected claims (e.g., creditworthiness, account standing) to third-party lenders using Groth16 ZK-SNARKs, without revealing underlying personal data.

---

Quick Links

Getting Started

• Architecture & Design — System design, data flows, and component overview

API Reference

• Integration Guide — Step-by-step API integration with curl and SDK examples
• Webhook Events — Event payloads, signature verification, and retry policy
• Rate Limits & Quotas — Per-endpoint rate limits and quota tiers
• TypeScript SDK — SDK installation, usage, and API reference

Compliance & Security

• SOC 2 Readiness — Trust Service Criteria mapping and gap analysis
• Incident Response Plan — Severity levels, roles, escalation, and communication templates
• Business Continuity Plan — RPO/RTO targets, failover procedures, and DR drills
• Key Rotation Procedures — Key inventory, rotation schedules, and zero-downtime procedures
• Risk Register — Enterprise risk identification, scoring, and mitigation
• Pentest Scope — Endpoint inventory and penetration testing scope
• Security Policy — Vulnerability reporting and responsible disclosure

Operations

• Production Configuration — Environment setup, deployment, and configuration
• Backup & Recovery — Backup procedures and recovery testing
• Rollback Runbook — Deployment rollback procedures