Skip to content

plan: un-collapse KYB regulated/unregulated sections and document verification-issue webhooks - #864

Draft
ls-bolt[bot] wants to merge 1 commit into
mainfrom
08-25-plan-kyb-docs-toc-verification-webhooks
Draft

plan: un-collapse KYB regulated/unregulated sections and document verification-issue webhooks#864
ls-bolt[bot] wants to merge 1 commit into
mainfrom
08-25-plan-kyb-docs-toc-verification-webhooks

Conversation

@ls-bolt

@ls-bolt ls-bolt Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The Regulated Platforms / Unregulated Platforms blocks on all four configuring-customers pages are collapsed inside an <AccordionGroup>, so they never reach the right-hand table of contents. Turn them into regular ## sections.
  • The KYC/KYB section documents only the terminal CUSTOMER.KYC_* / CUSTOMER.KYB_* decisions. Grid also ships VERIFICATION.* webhooks that carry the errors[] 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 shared kyc-unregulated.mdx snippet 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}/ and openapi/webhooks/verification-update.yaml — nothing invented. No OpenAPI file is edited, so there is no make build rebundle in this diff.

Changes: 5 files

  • mintlify/snippets/kyc/verification-webhooks.mdx (new) — the VERIFICATION.* events, how to read a VerificationError, remediation per error family, re-submit path, and a handler example
  • mintlify/global-p2p/onboarding/configuring-customers.mdx — un-collapse; move the generic individual/business field guidance above the new sections; promote the webhook heading
  • mintlify/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 heading

One 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 inside kyc-unregulated.mdx.

Full plan (code sketches, verification, risks): docs/plans/2026-08-25-kyb-docs-toc-and-verification-webhooks.md in this PR's diff.

Reply with a comment (e.g. LGTM) to approve — emoji reactions don't notify me here.

Requested by @pengying

@vercel

vercel Bot commented Aug 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Preview Aug 25, 2026 5:59pm
grid-wallet-demo Ignored Ignored Preview Aug 25, 2026 5:59pm

Request Review

@ls-bolt ls-bolt Bot added the bolt label Aug 25, 2026

Copy link
Copy Markdown

This stack of pull requests is managed by Graphite. Learn more about stacking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants