Fix invite-code mode API surface and TTL in docs#115
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
SeanROlszewski
force-pushed
the
fix/invite-code-docs-accuracy
branch
from
9adbfd0 to
e742d61
Compare
The invite-code documentation referenced a `.code` property on `IDKitInviteCodeRequest` that does not exist in the SDK. The actual API exposes `connectorURI` (TypeScript) / `connectorURL` (Swift), which is the same connector URL as QR mode with `&c=<code>&a=<app_id>` query params appended. Also fixes: - Code TTL: ten minutes → fifteen minutes (INVITE_CODE_TTL_SECONDS = 900) - Swift `IDKitInviteCodeRequest.requestID` type: `UUID` → `String` - React hook result field: `code` → `connectorURI` Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
SeanROlszewski
force-pushed
the
fix/invite-code-docs-accuracy
branch
from
e742d61 to
35f52a4
Compare
Takaros999
approved these changes
May 6, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
request.codedoes not exist — The invite-code documentation across all four pages (verification-flows, javascript, react, swift) referenced a.codeproperty onIDKitInviteCodeRequestthat is not part of the public API. The actual property isconnectorURI(TypeScript) /connectorURL(Swift) — the same connector URL shape as QR mode, with&c=<code>&a=<app_id>query params appended. Theworld.org/verifylanding page reads those params to render an invite-code-aware view.INVITE_CODE_TTL_SECONDSis900inrust/core/src/bridge.rs, which is 15 minutes. The docs said "ten minutes".requestIDtype isString, notUUID— In invite-code mode the request ID is an HKDF-derived hex string, not a UUID v4. The Swift wrapper correctly types this asStringonIDKitInviteCodeRequest(vsUUIDonIDKitRequestfor the QR flow).useIDKitInviteCodeRequestexposesconnectorURI, notcode.Files changed
verification-flows.mdxrequest.code→request.connectorURI(TS) /request.connectorURL(Swift)javascript.mdxrequest.code→request.connectorURI, API surface list correctedreact.mdxcode→connectorURIswift.mdxrequest.code→request.connectorURL,requestID: UUID→requestID: String, API surface list correctedTest plan
@worldcoin/idkit-coreand@worldcoin/idkitidkit-swiftINVITE_CODE_TTL_SECONDSin bridge.rs🤖 Generated with Claude Code