Skip to content

docs: sync documentation with document upload schema changes#522

Merged
pengying merged 1 commit into
mainfrom
docs/sync-20260528
May 28, 2026
Merged

docs: sync documentation with document upload schema changes#522
pengying merged 1 commit into
mainfrom
docs/sync-20260528

Conversation

@claude
Copy link
Copy Markdown
Contributor

@claude claude Bot commented May 28, 2026

Summary

Test plan

  • Verify PASSPORT upload examples include all required fields per IdentityDocumentUploadRequest schema
  • Review generated Mintlify docs render correctly

🤖 Generated with Claude Code

Update PASSPORT upload examples to include documentNumber and
issuingAuthority fields, which are now required for identity documents
after the document upload schema split in #517.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@claude claude Bot requested review from pengying and shreyav May 28, 2026 09:23
@vercel
Copy link
Copy Markdown

vercel Bot commented May 28, 2026

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

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 28, 2026 9:24am

Request Review

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 28, 2026

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

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview May 28, 2026, 9:25 AM

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 28, 2026

Greptile Summary

This documentation-only PR syncs the KYC guide with the schema split introduced in #517, which separated document uploads into identity and non-identity types. Both PASSPORT upload curl examples in kyc-unregulated.mdx now include the documentNumber and issuingAuthority fields that are required by the IdentityDocumentUploadRequest schema.

  • Added documentNumber and issuingAuthority to the individual KYC (customer) PASSPORT upload example.
  • Added the same two required fields to the KYB (beneficial owner) PASSPORT upload example, using distinct sample values to differentiate the two flows.

Confidence Score: 5/5

Safe to merge — documentation-only change that correctly adds two missing required fields to curl examples.

Both PASSPORT upload examples now include all required fields (documentNumber and issuingAuthority) that the IdentityDocumentUploadRequest schema mandates. No other files contain PASSPORT upload examples, and the regulated-platform KYC file has no document upload examples at all. The added sample values are realistic and distinct between the two examples.

No files require special attention.

Important Files Changed

Filename Overview
mintlify/snippets/kyc/kyc-unregulated.mdx Adds required documentNumber and issuingAuthority fields to both PASSPORT upload examples (individual KYC and KYB beneficial owner), aligning with the IdentityDocumentUploadRequest schema.

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant API as Grid API

    Dev->>API: POST /customers (customerType, personalInfo)
    API-->>Dev: "{ id: "Customer:..." }"

    Dev->>API: "POST /documents (multipart/form-data)<br/>documentHolder, documentType=PASSPORT<br/>documentNumber, issuingAuthority, country, file"
    API-->>Dev: "{ id: "Document:..." }"

    Dev->>API: POST /verifications (customerId)
    API-->>Dev: "{ verificationStatus: "IN_PROGRESS" | "RESOLVE_ERRORS" }"

    API-->>Dev: Webhook: CUSTOMER.KYC_APPROVED / KYC_REJECTED
Loading

Reviews (1): Last reviewed commit: "docs(kyc): add required fields to identi..." | Re-trigger Greptile

@pengying pengying merged commit ea63d5c into main May 28, 2026
8 checks passed
@pengying pengying deleted the docs/sync-20260528 branch May 28, 2026 23:55
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.

1 participant