Skip to content

docs(kyb): add file type and rejection info to document upload step - #869

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260827
Open

docs(kyb): add file type and rejection info to document upload step#869
claude[bot] wants to merge 1 commit into
mainfrom
docs/sync-20260827

Conversation

@claude

@claude claude Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds file type requirements (application/pdf, image/jpeg, image/png) and 10 MB size limit to KYB document upload step
  • Documents 422 DOCUMENT_REJECTED error for unreadable documents
  • Aligns with existing KYC individual document upload guidance for consistency

This change syncs the KYB documentation with the recent OpenAPI changes in #861 that defined supported file types and document rejection responses.

Test plan

  • Verified make build passes
  • Verified make lint passes with 0 errors

🤖 Generated with Claude Code

The KYC individual document upload already documented supported file
types (PDF, JPEG, PNG), size limit (10 MB), and 422 DOCUMENT_REJECTED
error. The KYB business document upload was missing this information.

Adds the same guidance for consistency.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 27, 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 Aug 27, 2026 11:29am
grid-wallet-demo Ignored Ignored Aug 27, 2026 11:29am

Request Review

@mintlify

mintlify Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Aug 27, 2026, 11:31 AM

@claude
claude Bot requested review from pengying and shreyav August 27, 2026 11:28
@greptile-apps

greptile-apps Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR expands the KYB supporting-document upload guidance with the accepted MIME types, 10 MB size limit, and the 422 DOCUMENT_REJECTED response for unreadable documents.

  • Documents supported PDF, JPEG, and PNG uploads.
  • States the maximum file size.
  • Describes common document-quality rejection conditions.

Confidence Score: 4/5

The PR appears safe to merge after addressing a non-blocking active-voice documentation issue.

The documented MIME types, size limit, and rejection response align with the current document-upload contract; only the passive construction in the new guidance needs cleanup.

Files Needing Attention: mintlify/snippets/kyc/kyc-unregulated.mdx

Important Files Changed

Filename Overview
mintlify/snippets/kyc/kyc-unregulated.mdx The new constraints and rejection behavior agree with the API contract, but one added sentence violates the documentation guide’s active-voice convention.
Prompt To Fix All With AI
### Issue 1
mintlify/snippets/kyc/kyc-unregulated.mdx:345
**Use active voice**

The passive phrase “is rejected” obscures the actor in this new guidance; naming the API directly makes the behavior clearer and follows the Mintlify documentation convention.

```suggestion
  Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`. Files must be `application/pdf`, `image/jpeg`, or `image/png`, and 10 MB or smaller. The API rejects a scan or photo that can't be read — out of focus, cut off, or black-and-white — with `422 DOCUMENT_REJECTED`.
```

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs(kyb): add file type and rejection i..." | Re-trigger Greptile


<Step title="Upload supporting documents">
Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`.
Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`. Files must be `application/pdf`, `image/jpeg`, or `image/png`, and 10 MB or smaller. A scan or photo that can't be read — out of focus, cut off, or black-and-white — is rejected with `422 DOCUMENT_REJECTED`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Use active voice

The passive phrase “is rejected” obscures the actor in this new guidance; naming the API directly makes the behavior clearer and follows the Mintlify documentation convention.

Suggested change
Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`. Files must be `application/pdf`, `image/jpeg`, or `image/png`, and 10 MB or smaller. A scan or photo that can't be read — out of focus, cut off, or black-and-white — is rejected with `422 DOCUMENT_REJECTED`.
Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`. Files must be `application/pdf`, `image/jpeg`, or `image/png`, and 10 MB or smaller. The API rejects a scan or photo that can't be read — out of focus, cut off, or black-and-white — with `422 DOCUMENT_REJECTED`.

Context Used: mintlify/AGENTS.md (source)

Prompt To Fix With AI
This is a comment left during a code review.
Path: mintlify/snippets/kyc/kyc-unregulated.mdx
Line: 345

Comment:
**Use active voice**

The passive phrase “is rejected” obscures the actor in this new guidance; naming the API directly makes the behavior clearer and follows the Mintlify documentation convention.

```suggestion
  Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`. Files must be `application/pdf`, `image/jpeg`, or `image/png`, and 10 MB or smaller. The API rejects a scan or photo that can't be read — out of focus, cut off, or black-and-white — with `422 DOCUMENT_REJECTED`.
```

**Context Used:** mintlify/AGENTS.md ([source](https://github.com/lightsparkdev/grid-api/blob/main/mintlify/AGENTS.md))

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants