-
Notifications
You must be signed in to change notification settings - Fork 15
docs(world-id): add Selfie Check Sandbox testing guide #142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
noamtfh
wants to merge
3
commits into
docs/sandbox-environment
Choose a base branch
from
docs/sandbox-selfie-check-testing
base: docs/sandbox-environment
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: "Testing Selfie Check in Sandbox" | ||
| description: "Coverage, critical user journeys, and known limitations for testing your Selfie Check integration in Sandbox." | ||
| "og:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" | ||
| "twitter:image": "https://raw.githubusercontent.com/worldcoin/developer-docs/main/images/docs/docs-meta.png" | ||
| --- | ||
|
|
||
| {/* cspell:ignore idkit DoB reinstalls */} | ||
|
|
||
| Sandbox lets you run the full [Selfie Check](/world-id/credentials/11) relying-party | ||
| journey end-to-end — from your surface, through IDKit, into the sandbox World ID app, | ||
| and back — without touching production identities or real proofs. | ||
|
|
||
| New to Sandbox? Start with [What is Sandbox?](/world-id/sandbox/what-is-sandbox) and | ||
| [How to get access](/world-id/sandbox/sandbox-access) before working through this | ||
| guide. | ||
|
|
||
| <Note> | ||
| In scope: the full relying-party journey — request handoff, consent, capture, | ||
| enrollment and matching, proof generation, and delivery of the proof. Out of scope: | ||
| production identity data and real-world uniqueness at scale. Sandbox accounts and | ||
| proofs are for integration testing only, not load testing, security certification, | ||
| or production sign-off. | ||
| </Note> | ||
|
|
||
| ## Coverage | ||
|
|
||
| Testing is organized by entry surface and user state, using the same [Hot, Cold, and | ||
| Semi-cold states](/world-id/idkit/verification-flows) as the rest of World ID: | ||
|
|
||
| - **Hot** — the user already has World ID installed. If they're already Selfie Check | ||
| enrolled, they go straight to face match; if not, World ID walks them through | ||
| enrollment first, then match. (Selfie Check has no distinct Warm flow — enrollment | ||
| happens inline within Hot, same as [Verification Flows](/world-id/idkit/verification-flows) | ||
| describes.) | ||
| - **Cold** — a new user with no World ID app: the full funnel, including install, | ||
| account creation, date of birth, invite code (iOS), enrollment, and Selfie Check. | ||
| - **Semi-cold** — an existing user without World ID on this device: reinstall and | ||
| account recovery, then Selfie Check. | ||
|
|
||
| | Entry surface | State | What it exercises | | ||
| | --- | --- | --- | | ||
| | Native app | Hot | Same-device: validated user presents a face credential; deep link into World ID and back. | | ||
| | Native app | Cold | Install → create account → add date of birth → redeem invite code → enroll → complete Selfie Check. | | ||
| | Native app | Semi-cold | Existing user reinstalls and recovers their account on a fresh device, then completes Selfie Check. | | ||
| | Web app | Hot | Cross-device: start on web, complete on phone via QR scan, proof returns to the web session. | | ||
| | Web app | Cold | Same cold funnel, cross-device via QR; proof returns to the originating web session. | | ||
| | Web app | Semi-cold | Same semi-cold recovery, cross-device via QR. | | ||
|
|
||
| ## Known limitations | ||
|
|
||
| - **Sandbox apps aren't published to the app stores.** As with other Sandbox testing, | ||
| install deep links won't route to a store listing the way they do in production — | ||
| see [How to get access](/world-id/sandbox/sandbox-access#things-to-know). This means | ||
| the Cold and Semi-cold journeys above can't be exercised exactly as they will be once | ||
| the app is on the App Store or Play Store. | ||
| - **iOS Semi-cold is currently limited.** The reinstall/login journey reliably works on | ||
| Android today. On iOS, if the user taps "Sign in" instead of "Sign up" mid-flow, | ||
| there's no path to add the invite code — they have to restart from a fresh QR or deep | ||
| link. Expect iOS Semi-cold to behave differently from Android until this is closed. | ||
|
Comment on lines
+58
to
+60
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't need to document this, we need to fix it :) |
||
| - **Invite-code handling in the Cold flow differs by platform.** Confirm how invite | ||
| codes are presented and redeemed on the platform you're targeting — see | ||
| [invite-code mode](/world-id/idkit/verification-flows#with-invite-code-mode). | ||
|
|
||
| ## Next step | ||
|
|
||
| Questions, or found a journey these scenarios don't cover? Reach out to your World | ||
| point of contact. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should have a dedicated "Testing the Cold Flow" that walks them through how to best test the cold flow.
We want to give them confidence that they can test the cold flow, not emphasize too much that it's not a valid atest.