plan: un-collapse KYB regulated/unregulated sections and document verification-issue webhooks - #864
Draft
ls-bolt[bot] wants to merge 1 commit into
Draft
Conversation
…ification-issue webhooks
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
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
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
configuring-customerspages are collapsed inside an<AccordionGroup>, so they never reach the right-hand table of contents. Turn them into regular##sections.CUSTOMER.KYC_*/CUSTOMER.KYB_*decisions. Grid also shipsVERIFICATION.*webhooks that carry theerrors[]array naming exactly what is wrong and how to fix it — currently undocumented in the guides. Add a shared snippet for it at the end of the KYC/KYB section.Approach
Replace each
<AccordionGroup>with two##headings.##rather than###/####because the sharedkyc-unregulated.mdxsnippet already carries its own###and####headings — anchoring the new sections at##makes those nest as proper ToC children on every page, with no edits to the shared snippets and no per-page heading depth that the snippets can't satisfy. Two pages need a small local reshuffle so the new##sections don't swallow sibling content that isn't about regulated/unregulated platforms.For part 2, every event name, field, error type, and endpoint comes from
openapi/components/schemas/{webhooks,verifications}/andopenapi/webhooks/verification-update.yaml— nothing invented. No OpenAPI file is edited, so there is nomake buildrebundle in this diff.Changes: 5 files
mintlify/snippets/kyc/verification-webhooks.mdx(new) — theVERIFICATION.*events, how to read aVerificationError, remediation per error family, re-submit path, and a handler examplemintlify/global-p2p/onboarding/configuring-customers.mdx— un-collapse; move the generic individual/business field guidance above the new sections; promote the webhook headingmintlify/payouts-and-b2b/onboarding/configuring-customers.mdx— un-collapse; fold a one-sentence###lead-in into its parent; add a webhook section (this page renders no webhook snippet today)mintlify/ramps/onboarding/configuring-customers.mdx— un-collapse (sentence case, matching this page); render the new snippet in the existing "Monitor verification status"mintlify/rewards/onboarding/configuring-customers.mdx— un-collapse; lift the<Info>callout out of the unregulated section; promote the webhook headingOne thing worth a reviewer opinion: the
##choice also promotes each page's webhook heading, so the ToC shape shifts slightly beyond the two named sections. If you'd rather keep those sections at###, say so — that variant needs a heading-demotion pass insidekyc-unregulated.mdx.Full plan (code sketches, verification, risks):
docs/plans/2026-08-25-kyb-docs-toc-and-verification-webhooks.mdin this PR's diff.Reply with a comment (e.g. LGTM) to approve — emoji reactions don't notify me here.
Requested by @pengying