docs(kyc): cover business customers in the hosted KYC/KYB link flow - #831
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Contributor
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript
|
JasonCWang
force-pushed
the
docs/kyc-kyb-verification-options
branch
from
August 14, 2026 00:39
db2b832 to
fb4495e
Compare
github-actions
Bot
added
the
breaking-change
Contributor
|
JasonCWang
force-pushed
the
docs/kyc-kyb-verification-options
branch
from
August 14, 2026 00:46
fb4495e to
c61a67f
Compare
JasonCWang
marked this pull request as ready for review
August 14, 2026 20:29
Contributor
Greptile SummaryExtends the hosted verification documentation and endpoint description to cover business KYB alongside individual KYC.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| mintlify/snippets/kyc/kyc-unregulated.mdx | Generalizes the hosted onboarding guide for individual KYC and business KYB, including creation examples, status handling, and sandbox advice. |
| mintlify/snippets/kyc/kyb-sandbox-suffixes.mdx | Introduces reusable documentation for deterministic business-verification sandbox suffixes. |
| mintlify/snippets/sandbox-verification.mdx | Replaces duplicated KYB suffix content with the shared snippet and links to the hosted-flow guide. |
| openapi/paths/customers/customers_{customerId}_kyc-link.yaml | Broadens the hosted-link endpoint description to document business KYB behavior and the direct API alternative. |
| openapi.yaml | Regenerates the bundled OpenAPI output with the updated hosted-link description. |
| mintlify/openapi.yaml | Regenerates the Mintlify OpenAPI bundle with the updated hosted-link description. |
Reviews (2): Last reviewed commit: "docs(kyc): cover business customers in t..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| |--------|---------| | ||
| | `UNVERIFIED` | Created, not yet submitted. Generating a link does not move it off this value | | ||
| | `PENDING` | Submitted; review under way | | ||
| | `APPROVED` | Passed — unlock funding and money movement | |
Contributor
There was a problem hiding this comment.
When an unregulated platform has not recorded End User Terms consent, this row incorrectly presents KYC/KYB approval as sufficient to unlock funding and money movement, causing customer-scoped transactions to be rejected despite the documented guidance.
Suggested change
| | `APPROVED` | Passed — unlock funding and money movement | | |
| | `APPROVED` | Passed verification. For unregulated platforms, record End User Terms consent before enabling funding and money movement | |
Knowledge Base Used: Customers and KYC
Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/kyc/verification-options.mdx
Line: 90
Comment:
**Approval omits the consent gate**
When an unregulated platform has not recorded End User Terms consent, this row incorrectly presents KYC/KYB approval as sufficient to unlock funding and money movement, causing customer-scoped transactions to be rejected despite the documented guidance.
```suggestion
| `APPROVED` | Passed verification. For unregulated platforms, record End User Terms consent before enabling funding and money movement |
```
**Knowledge Base Used:** [Customers and KYC](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/customers-and-kyc.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
The hosted link flow was documented only for individual customers, so
nothing told integrators that the same endpoint runs KYB for business
customers, or what a business needs to supply before the link is
generated. That had to be explained by hand.
Extend the existing unregulated-platform KYC/KYB content in Configuring
customers rather than adding a separate page, since that guide already
covers both onboarding paths:
- State that POST /customers/{customerId}/kyc-link serves both customer
types and that customerType selects the flow — INDIVIDUAL tracked on
kycStatus, BUSINESS on kybStatus — and what the KYB applicant
completes in the hosted flow.
- Split customer creation into individual and business tabs, with the
fields POST /customers actually requires for a business customer and
the three groups that are optional to the schema but required in
practice (contact channels, currency-driven, review-driven).
- Note that business information is prefilled into the hosted flow, so
it should be supplied before the link is generated.
- Generalize the end-to-end steps to cover both customer types, and
correct the places that referred to kycStatus for business customers.
Document the 003 sandbox suffix: a business registration number not
ending in 001, 002, or 003 auto-approves the customer on the spot,
leaving the hosted flow nothing to verify, so it requests no documents
and no beneficial owners. That reads as a broken KYB flow but isn't.
The suffix table moves into a shared snippet so the sandbox testing page
and this guide stay in sync.
Also broaden the kyc-link endpoint description to cover the KYB case and
point at the direct API alternative.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
JasonCWang
force-pushed
the
docs/kyc-kyb-verification-options
branch
from
August 19, 2026 18:52
c61a67f to
d3ffbab
Compare
JasonCWang
changed the title
JasonCWang
marked this pull request as draft
August 19, 2026 18:52
JasonCWang
marked this pull request as ready for review
August 19, 2026 20:06
JasonCWang
enabled auto-merge (squash)
August 19, 2026 20:31
pengying
approved these changes
Aug 20, 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.
What
Extends the existing unregulated-platform KYC/KYB content in Configuring customers so the hosted link flow covers business customers, not just individuals.
The hosted flow was documented only for
INDIVIDUAL. Nothing told integrators that the same endpoint runs KYB for business customers, or what a business needs to supply before the link is generated — so that had to be walked through by hand.This extends the guide that already covers both onboarding paths rather than adding a separate page:
POST /customers/{customerId}/kyc-linkserves both, andcustomerTypeselects the flow —INDIVIDUALtracked onkycStatus,BUSINESSonkybStatus. There is no dedicated KYB link endpoint. Says what the KYB applicant completes in the flow: company details, formation and ownership documents, control person, and beneficial owners at 25% or more.POST /customersactually requires (legalName,country,taxId,incorporatedOn) plus the three groups that are optional to the schema but required in practice — contact channels, currency-driven viaproviderRequiredCustomerFields, and everything the review needs.kycStatusfor business customers.The 003 suffix
A business
registrationNumbernot ending in001,002, or003auto-approves the customer on the spot in sandbox. The hosted flow then has nothing left to verify, so it asks for no documents and no beneficial owners — which looks exactly like a broken KYB flow.003avoids the auto-decision so document and UBO collection actually run.The suffix table moved into a shared snippet, so the sandbox testing page and this guide can't drift apart.
Also
Broadens the
kyc-linkendpoint description to cover the KYB case and name the direct API alternative, rather than describing only individual identity verification.Verification
make build+make lint— spec valid, 0 errors. Bundle diff is scoped to this one endpoint.#hosted-kyc-and-kyb-link-flowand the sandbox page's cross-link resolves to it.mint broken-linksreports nothing from any changed file.Docs-only — no schema or behavior changes.
🤖 Generated with Claude Code