Skip to content

docs(world-id): add Sandbox environment guide#141

Open
noamtfh wants to merge 4 commits into
mainfrom
docs/sandbox-environment
Open

docs(world-id): add Sandbox environment guide#141
noamtfh wants to merge 4 commits into
mainfrom
docs/sandbox-environment

Conversation

@noamtfh

@noamtfh noamtfh commented Jul 17, 2026

Copy link
Copy Markdown

Summary

  • Adds a new "Sandbox" section under World ID: What is Sandbox? and How to get access, covering the new production-like testing environment (own backend, own iOS/Android World ID builds, resettable accounts, valid IDKit destination).
  • Registers the pages under a new Sandbox group in docs.json, between IDKit and Credentials.

Why draft

Sandbox is still mid-rollout (Milestone 1 eng work targeted for 2026-07-21, Reddit e2e handoff targeted for 2026-07-31, and the live e2e round-trip test is currently blocked). Opening as a draft so it's reviewable now without implying the environment is ready for external developers to use today. Please confirm Milestone 1 status before marking ready for review / merging.

Content notes

  • iOS distribution via the public TestFlight link (testflight.apple.com/join/VZEurhHe) is confirmed settled — used as the primary install path.
  • Android access is intentionally left as "contact your World point of contact," since the specific distribution channel/links aren't finalized yet.

Test plan

  • npx cspell world-id/sandbox/*.mdx passes
  • docs.json validated as well-formed JSON
  • Confirm Sandbox rollout status (Milestone 1) before merging
  • Verify Android access instructions once that channel is finalized

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
world 🟢 Ready View Preview Jul 17, 2026, 10:45 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
world 🟡 Building Jul 17, 2026, 10:44 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread world-id/sandbox/sandbox-access.mdx Outdated
Comment on lines +45 to +51
## 2. Point your integration at Sandbox

1. **Update IDKit** to a version with Sandbox support.
2. **Select Sandbox** as the destination for your verification requests, instead of
Production.
3. Run a request from your surface — the handoff will open the sandbox World ID app and
return a proof to your session over the bridge.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit. we could say:

  1. Update IDKit to the latest version
  2. Set environment: sandbox in your IDKit configuration

nothing else is required

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 616ca4c — thanks!

@noamtfh
noamtfh marked this pull request as ready for review July 20, 2026 16:59
noamtfh and others added 4 commits July 20, 2026 10:45
Introduce a new Sandbox section covering the dedicated, production-like
testing environment: what it is and how to install the sandbox World ID
app and point an integration at it.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…tion only

Per the Android team, Google Play testing track is not being used for
Sandbox distribution right now.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Address review feedback: replace the vague "update IDKit / select
Sandbox" steps with the concrete config change (environment: sandbox)
and drop the extra step describing IDKit's normal runtime behavior.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

## 2. Point your integration at Sandbox

1. **Update IDKit** to the latest version.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest or "> version n" @Takaros999 ?

Comment on lines +10 to +12
Sandbox is a dedicated, production-like environment for building and testing your
World ID integration. It runs alongside Production as its own environment, with its
own backend and its own builds of the World ID app for iOS and Android.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's important to mention somehow that Sandbox is "stable" or "reliable" and that it runs the same, well-tested and validated builds as Prod.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants