Developer Portal

The Worldcoin Developer Portal provides tools to interact with the Worldcoin SDK. Easiest way to get started with World ID.

About World ID

World ID is a protocol that lets you prove a human is doing an action only once without revealing any personal data. Stop bots, stop abuse.

World ID uses a device called the Orb which takes a picture of a person's iris to verify they are a unique and alive human. The protocol uses Zero-knowledge proofs so no traceable information is ever public.

World ID is meant for on-chain web3 apps, traditional cloud applications, and even IRL verifications.

Getting started with World ID

Regardless of how you landed here, the easiest way to get started with World ID is through the the Dev Portal.

World ID Demos

Want to see World ID in action? We have a bunch of Examples.

📄 Documentation

We have comprehensive docs for World ID at https://id.worldcoin.org/docs.

🗣 Feedback

World ID is in Beta, help us improve! Please share feedback on your experience. You can find us on Discord, look for the #world-id channel. You can also open an issue or a PR directly on this repo.

🧑‍💻 Development & testing

The following command will start the DB, the Hasura server and the Next.js app. It will also automatically apply Hasura migrations and metadata.

docker compose up -d --abort-on-container-exit
cd web && yarn dev

Updating DB model & permissions

If you will update anything related to Hasura (database model, permissions, etc.) the easiest way is with the Hasura console.

1. Follow instructions to install the Hasura CLI.
2. Launch the Hasura console.

   cd hasura
   hasura console --endpoint http://localhost:8080 --admin-secret secret!

Warning Make sure to only make the changes in the Hasura console (usually http://localhost:9665), if you make changes on http://localhost:8080the migrations will not be generated and your changes will be lost.

💡 The admin secret in stored in docker-compose.yml file in the root of the repo.