Add CAPTCHA feature docs - #759
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
4641ad8 to
ddd60df
Compare
| <Warning> | ||
| `signUpWithWallet` exposes a `captchaToken` parameter but does not forward it, so the request will be rejected when captcha is enabled. Use `loginOrSignupWithWallet` for wallet signup flows. | ||
| </Warning> |
There was a problem hiding this comment.
uhhh this might be a bug in the SDK 😅 , we should prob fix that and remove this warning
There was a problem hiding this comment.
I think we should still address this before open beta
|
|
||
| React Native and Expo apps render the widget and attach tokens themselves. `@turnkey/react-native-wallet-kit` does not render Turnstile for you, but its `useTurnkey()` methods forward their params straight to `@turnkey/core`, so you pass `captchaToken` to them exactly as the examples below pass it to a core client. | ||
|
|
||
| <CaptchaCoreBasics /> |
There was a problem hiding this comment.
Re-using the core version warning works well but we should also include the minimum version @turnkey/react-native-wallet-kit should be at.
There was a problem hiding this comment.
There isn't a minimum version for react-native-wallet-kit. Since there are no captcha features within the RN kit, you must use core to build the UI yourself.
core is 2.4.0 and is react-wallet-kit is 2.3.0 minimum.
There was a problem hiding this comment.
The UI might not be there but every @turnkey/react-native-wallet-kit version depends on a specific @turnkey/core version, not sure if you (as a user) can modify it but I feel it's prob safer to just use the RWNK version that ships with the correct core version.
cdc2475 to
591b900
Compare
ethankonk
left a comment
ethankonk
left a comment
There was a problem hiding this comment.
One more comment, also responded to some of the unresolved ones above!
| <Warning> | ||
| `signUpWithWallet` exposes a `captchaToken` parameter but does not forward it, so the request will be rejected when captcha is enabled. Use `loginOrSignupWithWallet` for wallet signup flows. | ||
| </Warning> |
There was a problem hiding this comment.
I think we should still address this before open beta
2 participants
Summary
Adds a new documentation page for Turnkey's CAPTCHA protection feature (powered by Cloudflare Turnstile).
New page
features/authentication/captcha.mdx— covers:@turnkey/react-wallet-kitautomatically renders the Turnstile widget and enforces CAPTCHA on all auth flows — no extra integration code requiredNavigation
Added
features/authentication/captchato docs.json under the Authentication section (Documentation tab → Features → Authentication), positioned after the Sessions page.Notes
/images/authentication/img/captcha-dashboard-toggle.png