Documentation
Comprehensive guides and references for building privacy-preserving identity verification with ZK-ID.
Getting Started
Getting Started
This guide walks you through everything you need to know to integrate zk-id into your application, from initial setup to production deployment.
Contributing Guide
Thank you for your interest in contributing to zk-id! This guide will help you understand the project structure, development workflow, and how to make
Changelog
All notable changes to this project will be documented in this file.
Integration Guide
Complete guide to integrating zero-knowledge identity verification into your application
Architecture
Architecture
This document describes the technical architecture of zk-id.
Protocol Specification
This document specifies the zk-id protocol for privacy-preserving identity verification.
Circuit Diagrams
**Version:** 0.7.4
Circuit Complexity
This document tracks the complexity of each zk-id circuit to monitor growth and detect unexpected increases.
Schema Extensibility
How the zk-id credential schema works, why it is fixed, and how to extend it.
Security
Security Policy
We take security seriously. If you discover a security vulnerability in zk-id, please report it responsibly.
Threat Model
**Date:** 2026-02-09
Security Audit
This document tracks the requirements for a production-ready, audit-worthy v1.0.0 release of zk-id. It is intended as a guide for internal review and
Cryptographic Parameters
This document details the cryptographic parameters used in zk-id circuits and implementations.
Signed Circuits
This repo includes optional circuits that verify issuer signatures **inside** the proof.
Security Hardening
This document describes security improvements implemented in v0.7, addressing findings from the security audit.
Operations
Deployment Guide
**Version:** 1.0.0
Reproducible Builds
This document provides step-by-step instructions for reproducing circuit artifacts from source. Following these exact steps should produce cryptograph
Migration Guide
This document describes breaking changes and migration steps between versions.
Development
Reference
Verification Scenarios
Built-in verification scenarios for common age and identity verification use cases.
Standards & Compliance
This document describes how zk-id maps to existing identity verification standards, particularly ISO 18013-5 (mobile Driving License) and ISO 18013-7
Compliance Documentation
How zk-id maps to regulatory requirements for age verification and digital identity.
Roadmap
This roadmap focuses on security, interoperability, and production readiness. Dates are estimates.
Project Tickets
These are concrete tickets derived from the near-term roadmap. Use them as GitHub issues or a backlog seed.