docs(idkit): document debug report + v4 accuracy fixes#133
Merged
Conversation
Debug report (idkit#287): getDebugReport() on requests and React hooks, onError(errorCode, debugReport?), and IDKitDebugReport/MiniAppDebugInfo types — documented across javascript, react, error-codes, and mini-apps.
v4 example/schema accuracy: response identifier orb -> proof_of_human for protocol 4.0 (orb kept for v3/legacy); add user_presence_completed to verify request schemas; document the session_<128 hex> id format; drop credential_genesis_issued_at_min from verify response items (it is a request-side constraint, not returned).
Preset guidance: SKILL.md and integration-prompt now recommend proofOfHuman/passport (v4, with legacy fallback) over orbLegacy/secureDocumentLegacy (3.0-only), matching credentials.mdx.
Other fixes: 4-0-migration CredentialRequest("orb")->"proof_of_human"; onchain rp_id/genesis result-mapping; signRequest options-object signature in the LLM prompt; kotlin IDKitRequestConfig import; remove stray character in from-idkit-standalone.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Takaros999
previously approved these changes
Jun 24, 2026
| In JS and React, match these with `IDKitErrorCodes`. Kotlin and Swift expose the same raw values through their `IDKitErrorCode` enums. | ||
| In JS and React, match these with `IDKitErrorCodes`. Kotlin and Swift expose the same raw values through their `IDKitErrorCode` enums. | ||
|
|
||
| <Note>The `IDKitDebugReport` is JS-only, exported from `@worldcoin/idkit-core` and re-exported from `@worldcoin/idkit`; the related `MiniAppDebugInfo` type is exported from `@worldcoin/idkit-core` only. The Kotlin, Swift, and Go SDKs do not provide it.</Note> |
Contributor
There was a problem hiding this comment.
nit. this is unessecary
Removed note about IDKitDebugReport and MiniAppDebugInfo from error-codes.mdx.
Takaros999
approved these changes
Jun 25, 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
Documents the new IDKit debug report (idkit#287) across the World ID docs, plus a set of accuracy fixes surfaced while auditing the IDKit docs against the current SDK source.
Debug report (idkit#287)
getDebugReport(): IDKitDebugReportonIDKitRequest/IDKitInviteCodeRequestand on the React hook results —javascript.mdx,react.mdx.onError(errorCode, debugReport?)— the new optional second argument (passed for flow/bridge errors; host-app verify failures such asfailed_by_host_appomit it).IDKitDebugReport/MiniAppDebugInfo(incl. themini_appnative-transport fields) —javascript.mdx,error-codes.mdx,mini-apps.mdx.v4 example & schema accuracy
identifier:orb→proof_of_humanfor protocol 4.0 examples (snippet + OpenAPI);orbkept for v3/legacy. The v4 identifier is the credential type — confirmed via the signal-hash keying (bridge.rs:482insert bycredential_type,:291lookup byidentifier).user_presence_completedadded to the verify request schemas (IDKit always sends it).session_iddocumented assession_<128 hex characters>; fixed unrealistic examples.credential_genesis_issued_at_minfrom the verify response-item schemas (it's a request-side constraint, never returned in the result).Preset guidance
SKILL.mdandintegration-prompt.mdxnow recommendproofOfHuman/passport(v4, with legacy fallback) instead oforbLegacy/secureDocumentLegacy(3.0-only), matchingcredentials.mdx.Other fixes
4-0-migration.mdx:CredentialRequest("orb")→"proof_of_human"(invalidCredentialType).onchain-verification.mdx: correctedrp_idand genesis result-mapping (neither is a result field).integration-prompt.mdx:signRequest({ signingKeyHex, action })options-object signature + camelCase→snake_caserp_contextmapping note.kotlin.mdx: added the missingIDKitRequestConfigimport.from-idkit-standalone.mdx: removed a stray character.Verification
All findings were verified against the
worldcoin/idkitSDK source (including the Rust core) before applying.🤖 Generated with Claude Code