docs(kyc): align sandbox verification and onboarding docs with implemented behavior - #815
Merged
akanter merged 2 commits intoAug 11, 2026
Conversation
…ented behavior The sandbox suffix tables described a design that never shipped. Verified against dev and prod (2026-08-11) and corrected: - Individual suffixes resolve kycStatus AT CREATION (001 PENDING / 002 REJECTED / 003 UNVERIFIED / other APPROVED); terminal suffixes make POST /verifications return 400, so only 001 and 003 are submittable. - The 003 suffix simulates a correctable provider rejection (POOR_QUALITY_DOCUMENT), not an EDD MISSING_FIELD flow; replaced the fictional edd.* example with the verified fix-and-resubmit loop. - Business customers are created UNVERIFIED and resolve on submission; 002/other skip validation entirely, 001/003 go through full KYB validation. Responses use kybStatus. - BO suffixes resolve when the owning business resolves via its suffix. - Individual verification requires an identity document (PASSPORT single image, DRIVERS_LICENSE/NATIONAL_ID front+back) and taxIdType/taxIdentifier; the docs called documents optional. - kycStatus starts UNVERIFIED (docs said PENDING). - fullName must parse into given + family name; single-word names are refused at submission. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
akanter
marked this pull request as ready for review
August 11, 2026 14:23
Contributor
Greptile SummaryThe PR updates public KYC/KYB documentation to reflect implemented status transitions, identity-document requirements, sandbox suffix behavior, and the correct fix-and-resubmit flow.
Confidence Score: 4/5The PR appears safe to merge, with one non-blocking documentation-structure issue in the sandbox remediation workflow. The documented API requests and status values align with repository contracts, while the newly added four-stage procedure should be converted from numbered Bash comments into Mintlify Steps components. Files Needing Attention: mintlify/snippets/sandbox-verification.mdx
|
| Filename | Overview |
|---|---|
| mintlify/snippets/kyc/kyc-unregulated.mdx | Updates hosted and API-driven onboarding guidance with corrected lifecycle, name, document, and error-response requirements; no actionable defect identified. |
| mintlify/snippets/sandbox-verification.mdx | Corrects sandbox KYC/KYB suffix behavior and examples, but formats the new sequential remediation procedure contrary to the repository’s Steps-component requirement. |
Prompt To Fix All With AI
### Issue 1
mintlify/snippets/sandbox-verification.mdx:38-40
**Sequential workflow lacks Steps structure**
The new four-stage fix-and-resubmit procedure uses numbered comments inside one Bash block instead of the required `<Steps>` and `<Step>` components, reducing the workflow's scannability and preventing each request from presenting its expected outcome separately.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs(kyc): align sandbox verification an..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ch-brian
approved these changes
Aug 11, 2026
akanter
deleted the
08-11-docs_kyc_align_sandbox_verification_and_onboarding_docs_with_implemented_behavior
branch
August 11, 2026 14:56
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.
The sandbox KYC/KYB suffix documentation (shipped with #726) described a design that never made it to the implementation, and the onboarding guide predated the identity-document requirement. Every claim below was verified empirically against dev and prod (2026-08-11), including a full prod run of the fix-and-resubmit loop.
snippets/sandbox-verification.mdxkycStatusat creation (001PENDING /002REJECTED /003UNVERIFIED / any other APPROVED); terminal suffixes makePOST /verificationsreturn400, so only001and003customers are submittable. The old table claimed all suffixes resolved at verification time.003simulates a correctable provider rejection (POOR_QUALITY_DOCUMENT), not an EDDMISSING_FIELDflow — replaced the fictionaledd.*example with the verified fix-and-resubmit loop (create incomplete → readerrors[]→ PATCH fields + upload document → resubmit →PENDING_MANUAL_REVIEW).UNVERIFIEDand resolve on submission:002/other skip data and document validation entirely;001/003go through full KYB validation. Business responses usekybStatus, notkycStatus.snippets/kyc/kyc-unregulated.mdxPASSPORTsingle image;DRIVERS_LICENSE/NATIONAL_IDas FRONT+BACK) plustaxIdType/taxIdentifier— the guide called documents optional ("if requested") and the error example showed a proof-of-address case; swapped to the realMISSING_IDENTITY_DOCUMENTshape.kycStatusstarts atUNVERIFIED(guide saidPENDING) and moves toPENDINGon submission/hosted-flow completion.fullNamemust parse into a given + family name; single-word names are refused by the provider at submission.🤖 Generated with Claude Code