docs: add IDKit invite-code mode page by SeanROlszewski · Pull Request #111 · worldcoin/developer-docs

SeanROlszewski · 2026-05-01T18:43:28Z

Summary

Documents invite-code mode (WDP-73 / idkit app-9428): the user enters a 6-character code in World App, which uses it as the entry point to in-app onboarding flows that fulfill the IDKit request.
Adds a new Verification Flows page (world-id/idkit/verification-flows.mdx) covering hot, warm, and cold paths a user can take when an app requests a World ID proof — including the invite-code flow.
Invite-code migration guide and per-SDK code examples added to the JavaScript, React, and Swift SDK reference pages.
Cross-link from integrate.mdx; sidebar entry added to navigation.
Constraints flagged: iOS-only on the World App side, selfieCheckLegacy is the only supported preset today.
Fixes inconsistent title casing across IDKit section pages.

Test plan

Verify the local Mintlify preview renders all new and changed pages correctly
Confirm nav links in the IDKit section resolve without 404s
Check that invite-code SDK examples render properly in JavaScript, React, and Swift reference pages
Verify redirects from old paths (e.g. /world-id/idkit/invite-code) land correctly

🤖 Generated with Claude Code

Documents the cross-device verification flow added in idkit APP-9428, where the relying party shows a 6-character code the user types into World App on a different device instead of scanning a QR. - New page world-id/idkit/invite-code.mdx covering when to use the mode, the code format, lifecycle, and JS/React/Swift integration. - Wired into IDKit nav between Integrate and Signatures. - Cross-link from the standard Integrate page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

SeanROlszewski · 2026-05-01T18:46:10Z

+
+## When to use it
+
+Use invite-code mode when the relying party (your app) and World App are reliably **on different devices** — for example, a desktop browser experience where the user has World App on their phone. Typing a 6-character code is more robust than asking the user to point a phone camera at their own laptop screen.


This isn't the reason we built it, but is something we ensured worked. The reason to use this feature is to expedite onboarding users into the World Network. The app uses the code to show in-app flows that users complete as part of onboarding to respond to the IDKit request.

- Reframe "When to use it" to lead with the onboarding use case (the hero use case is letting World App run in-app onboarding flows so users can satisfy a credential they don't yet hold); cross-device is now described as a secondary fit. - Switch JS/React/Swift examples and the migration diff to selfieCheckLegacy so the doc reflects the current hero preset. - Remove the "easier to read aloud" line and the reference to the example apps under "Display the code" — a React component will ship for that surface. - Update the cross-link in integrate.mdx to match the new framing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Trim the overview and move per-SDK details to the existing reference pages so the structure matches how other IDKit features are documented. - Tighten the lede; collapse "When to use it" to two paragraphs. - Drop the Crockford / check-character internals — feature pages don't explain crypto details (signatures.mdx is the spec page). - Drop the inline "Migrating from QR mode" section — migration content belongs on 4-0-migration.mdx. - Replace the three Markdown API tables with a "SDK references" link list pointing into the per-language pages. - Add a Warning callout about generating rp_context server-side. - Show the RpContext(...) constructor in the Swift sample so it parallels JS/React. - Add "Invite-code mode" sections to javascript.mdx, react.mdx, and swift.mdx using the existing terse-bullet style of those pages. - Add IDKit.requestWithInviteCode and selfieCheckLegacy to the JS entry-points list. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Invite-code redemption is currently shipped only in World App for iOS; Android users cannot redeem a code today. Surface the constraint as a Note callout on the overview page and append it to the cross-link in integrate.mdx so anyone evaluating the feature sees it. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Invite-code mode currently only works with the selfie-check preset. Add a Note alongside the iOS-only one so the constraint is visible on the overview page; the docs will be updated as support is added for other credentials. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Replace the prose migration section in verification-flows with before/after code snippets in the JavaScript, React, and Swift SDK reference pages. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Introduce deferred deep linking concept in cold flow section - Fix App Clip flow: selection only, NFC scan happens in full app - Update invite-code note to explain why it's iOS-only - Remove world.org/verify reference from landing page step - Remove code format section and countdown mention from lifecycle - Move integrate.mdx Note to step 4, reframe as verification flows intro - Add mermaid sequence diagrams for all cold flow variants Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Standardize to title case: "Verification Flows", "On-chain Verification", and "JavaScript". Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

SeanROlszewski marked this pull request as draft May 1, 2026 18:43

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

mintlify Bot deployed to staging May 1, 2026 18:54 View deployment

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

mintlify Bot deployed to staging May 1, 2026 19:01 View deployment

mintlify Bot deployed to staging May 1, 2026 19:07 View deployment

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

Apply suggestion from @SeanROlszewski

f48194a

mintlify Bot deployed to staging May 1, 2026 19:08 View deployment

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

mintlify Bot deployed to staging May 1, 2026 19:13 View deployment

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/integrate.mdx Outdated

Apply suggestion from @SeanROlszewski

2ee44c4

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

Apply suggestion from @SeanROlszewski

0374aee

mintlify Bot deployed to staging May 1, 2026 19:20 View deployment

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

Apply suggestion from @SeanROlszewski

0de1f5c

SeanROlszewski commented May 1, 2026

View reviewed changes

Comment thread world-id/idkit/invite-code.mdx Outdated

Apply suggestion from @SeanROlszewski

c7c1115

mintlify Bot deployed to staging May 1, 2026 19:20 View deployment

mintlify Bot deployed to staging May 1, 2026 19:21 View deployment

mintlify Bot deployed to staging May 1, 2026 19:22 View deployment

mintlify Bot deployed to staging May 6, 2026 18:38 View deployment

docs: soften cold flow intro wording

e41250c

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

mintlify Bot deployed to staging May 6, 2026 18:41 View deployment

SeanROlszewski marked this pull request as ready for review May 6, 2026 19:01

Merge branch 'main' into docs/idkit-invite-code-mode

f77caac

mintlify Bot deployed to staging May 6, 2026 19:02 View deployment

docs: move invite-code migration to SDK references as code examples

eb527f6

Replace the prose migration section in verification-flows with before/after code snippets in the JavaScript, React, and Swift SDK reference pages. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

mintlify Bot deployed to staging May 6, 2026 19:08 View deployment