{"id":25633090,"url":"https://github.com/zkemail/prove-email-docs","last_synced_at":"2026-06-15T19:30:20.232Z","repository":{"id":206022345,"uuid":"715632457","full_name":"zkemail/prove-email-docs","owner":"zkemail","description":"Welcome to the Prove.email Documentation Hub, the central repository for comprehensive documentation on the zk email project suite. ","archived":false,"fork":false,"pushed_at":"2024-07-24T08:39:46.000Z","size":3464,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-07-25T05:56:58.149Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zkemail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-07T14:25:58.000Z","updated_at":"2024-07-24T08:39:49.000Z","dependencies_parsed_at":"2024-07-24T05:59:43.892Z","dependency_job_id":null,"html_url":"https://github.com/zkemail/prove-email-docs","commit_stats":null,"previous_names":["zkemail/prove-email-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fprove-email-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fprove-email-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fprove-email-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fprove-email-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zkemail","download_url":"https://codeload.github.com/zkemail/prove-email-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240240270,"owners_count":19770271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-22T21:27:55.869Z","updated_at":"2026-06-15T19:30:20.175Z","avatar_url":"https://github.com/zkemail.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZK Email Documentation Hub\n\n![Prove Email Logo](.gitbook/assets/ProveEmailLogo.png)\n\nWelcome to the ZK Email Documentation Hub, the central repository for comprehensive documentation on the ZK Email project suite. This hub serves as your one-stop guide to understanding and implementing our email verification solutions powered by zero-knowledge proof technology.\n\n## ZK Email Project Repos\n\nWe have several repos within the ZK Email ecosystem. Developers can use these to build their own custom email verification circuits.\n\n[ZK Email SDK](zk-email-sdk/): Use this to build a new kind of ZK Email proofs out of the box with 8 lines of JSON, and automatically have proof infrastructure deployed for you. We recommend this for all developers new to ZK Email.\n\n[ZK Email Verifier](https://github.com/zkemail/zk-email-verify): Build custom circuits, smart contracts, and frontend utils. This SDK will likely require ZK knowledge to be able to use, and gives more customizability than the [ZK Email SDK](zk-email-sdk/).\n\n[Email Wallet](https://github.com/zkemail/email-wallet): A smart contract wallet controlled by your email. You can understand [how to hit the API](email-wallet/api-documentation.md) from a frontend easily, [run your own relayer](email-wallet/relayer-infrastructure.md) if you like, or [define your own extensions](email-wallet/email-wallet-extensions-sdk.md) to add functionality.\n\n[Account Recovery](account-recovery/relayer-api.md): Explains the interfaces to call account recovery functions from a frontend API, and explains the smart contract architecture for wallets to customize. Used toenable and trigger recovery on any Safe or 7579-compatible wallet.\n\n[Oauth Login](login-with-zk-email-oauth-api.md):  Explains how to hit our APIs from a frontend to be able to login via emails with ZK Email, and optionally request scopes like temporary access to assets.\n\n[ZK Regex](https://github.com/zkemail/zk-regex): A library to do regex verification in circom. The zk-regex CLI takes in a regex and outputs a ZK circuit.\n\n## Projects that use ZK Email\n\nThere are many real world applications that currently use our sdks. Here's a list of a few notable ones\n\n* [ZKP2P: ](https://zkp2p.xyz/)Decentralized Venmo \u003c\u003e USDC Bridge\n* [Email Wallet:](https://emailwallet.org) Send transactions via email or act as a Safe multisig signer!\n* [Email Account Recovery](https://prove.email/blog/recovery): Use emails as guardians for any smart wallet or multisig.\u0026#x20;\n* [Nozee:](https://nozee.xyz) Anonymous Proofs of Email Domain via JWTs\n* [Proof of Twitter:](https://twitter.prove.email/) Verify your twitter username on chain using zk proofs\n\n## Quick Start\n\nTo get started with ZK Email, follow these steps:\n\n1. **Choose the Project Component**: Select the project component you're interested in from our list of SDKs, templates, and examples.\n2. **Read the README Guide**: Each section comes with a \"README\" guide. Make sure to read it to understand how the technology works and to get started with the basic setup.\n3. **Dive into Specific Documentation**: For detailed information and advanced configurations, delve into the specific documentation of the component you've chosen. Check out our [How to Set Up Proof of Twitter Example](https://prove.email/blog/twitter) blog post for a step-by-step tutorial showcasing a practical example of how our SDKs can be implemented for a custom ZK email circuit, and our [Github](https://github.com/zkemail) to see code for other demos.\n4. **Regularly Check for Updates**: Since we frequently make changes to enhance functionality and security, it's crucial to keep your circuits package up-to-date.\n\nPlease read our [CONTRIBUTING.md](contributing.md) for details on our how you can contribute to Prove.email, and the process for submitting pull requests to us.\n\n## License\n\nThis documentation is licensed under the [MIT License](https://github.com/zkemail/prove-email-docs/blob/docs/LICENSE.md).\n\n## Support and Contact\n\nIf you need help or have questions, please join our community chat on [Telegram](https://t.me/zkemail).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkemail%2Fprove-email-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzkemail%2Fprove-email-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkemail%2Fprove-email-docs/lists"}