Skip to content

add document types#441

Open
wuvictor-95 wants to merge 2 commits intomainfrom
05-05-add_document_types
Open

add document types#441
wuvictor-95 wants to merge 2 commits intomainfrom
05-05-add_document_types

Conversation

@wuvictor-95
Copy link
Copy Markdown
Contributor

No description provided.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 5, 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 5, 2026 11:24pm

Request Review

Copy link
Copy Markdown
Contributor Author

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

✱ Stainless preview builds

This PR will update the grid SDKs with the following commit messages.

kotlin

feat(api): add 7 new document type enum values to documents

openapi

feat(api): add business verification document types to DocumentType enum

python

feat(api): add 7 new document type values to documents resource

typescript

feat(api): add document type enum values to documents resource

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-kotlin studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ✅lint ✅test ✅

grid-openapi studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗

grid-python studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ✅lint ✅test ✅

pip install https://pkg.stainless.com/s/grid-python/0613c30eb9a6362d8518e54d8e4ad0eca66f948e/grid-0.0.1-py3-none-any.whl
grid-typescript studio · code · diff

Your SDK build had at least one "error" diagnostic, but this did not represent a regression.
generate ❗build ✅lint ❗test ✅

npm install https://pkg.stainless.com/s/grid-typescript/b373a8ef0f1d36d8f433b5b2f21fe4065757bdf6/dist.tar.gz

This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-05 23:30:44 UTC

@wuvictor-95 wuvictor-95 marked this pull request as ready for review May 5, 2026 22:54
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Greptile Summary

This PR expands the DocumentType enum with 7 new values (ELECTRICITY_BILL, RENT_OR_LEASE_AGREEMENT, DIRECTOR_REGISTRY, TRUST_AGREEMENT, STATE_COMPANY_REGISTRY, PARTNERSHIP_CONTROL_AGREEMENT, PARTNERSHIP_AGREEMENT) and reorganises the verification category descriptions, replacing the old "Company details" grouping with purpose-specific control/ownership/proof-of-address groupings.

  • New types added — 7 enum values across control structure, ownership structure, and proof-of-address categories; BANK_STATEMENT and TAX_RETURN also gain their first documented category assignment.
  • MISSING_COMPANY_DETAILS_DOCUMENT gap — the error type is removed from the VerificationError acceptedDocumentTypes docs and lookup table, but still exists in the VerificationErrorType enum. Integrators receiving this error have no documented resolution path.
  • Uncategorised legacy typesPROOF_OF_ADDRESS, INFORMATION_STATEMENT, INCUMBENCY_CERTIFICATE, and GOOD_STANDING_CERTIFICATE are still in the enum but stripped of their category descriptions, leaving them undocumented for new integrators.

Confidence Score: 3/5

Needs the MISSING_COMPANY_DETAILS_DOCUMENT gap resolved before merging.

The VerificationErrorType enum still exposes MISSING_COMPANY_DETAILS_DOCUMENT as a valid value, but the VerificationError documentation no longer tells integrators what documents resolve it. Any integrator receiving this error after the docs update would have no self-service path to resolution.

openapi/components/schemas/verifications/VerificationError.yaml and VerificationErrorType.yaml need to be consistent — either both drop MISSING_COMPANY_DETAILS_DOCUMENT or both document it with accepted types.

Important Files Changed

Filename Overview
openapi/components/schemas/verifications/VerificationError.yaml Removes MISSING_COMPANY_DETAILS_DOCUMENT from acceptedDocumentTypes documentation and lookup table, but that error type still exists in VerificationErrorType.yaml — creating a documentation gap for integrators who receive it.
openapi/components/schemas/documents/DocumentType.yaml Adds 7 new document type enum values and rewrites category descriptions; several previously-categorized types are now uncategorized in the description.
openapi.yaml Generated bundle updated to reflect source changes; content is consistent with edits to openapi/ source files.
mintlify/openapi.yaml Generated Mintlify bundle updated to reflect source changes; content mirrors openapi.yaml changes as expected.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    DT[DocumentType enum]
    DT --> ID[Identity]
    DT --> BLP[Business - Legal presence]
    DT --> BCS[Business - Control structure]
    DT --> BOS[Business - Ownership structure]
    DT --> POA[Proof of address]
    DT --> UNCATEGORISED[Uncategorised]
    BCS --> DIRECTOR_REGISTRY & TRUST_AGREEMENT & STATE_COMPANY_REGISTRY & PARTNERSHIP_CONTROL_AGREEMENT
    BOS --> SHAREHOLDER_REGISTER & PARTNERSHIP_AGREEMENT
    POA --> UTILITY_BILL & ELECTRICITY_BILL & RENT_OR_LEASE_AGREEMENT & BANK_STATEMENT & TAX_RETURN
    UNCATEGORISED --> PROOF_OF_ADDRESS & INFORMATION_STATEMENT & INCUMBENCY_CERTIFICATE & GOOD_STANDING_CERTIFICATE
    VET[VerificationErrorType enum] -->|still contains| MCDOC[MISSING_COMPANY_DETAILS_DOCUMENT]
    VE[VerificationError docs] -->|no longer documents| MCDOC
Loading

Comments Outside Diff (1)

  1. openapi/components/schemas/verifications/VerificationError.yaml, line 24-46 (link)

    P1 MISSING_COMPANY_DETAILS_DOCUMENT removed from docs but still live in enum

    MISSING_COMPANY_DETAILS_DOCUMENT is still present in VerificationErrorType.yaml (line 6) as a valid enum value, meaning the API can still return a VerificationError with that type. However, this PR removes it from the acceptedDocumentTypes description — both from the prose list and from the lookup table. Integrators who receive this error will have no documented guidance on which document types to upload to resolve it.

    Either MISSING_COMPANY_DETAILS_DOCUMENT should be removed from VerificationErrorType.yaml (if the error type is truly retired), or its acceptedDocumentTypes row should be restored with the new document types that satisfy it.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: openapi/components/schemas/verifications/VerificationError.yaml
    Line: 24-46
    
    Comment:
    **`MISSING_COMPANY_DETAILS_DOCUMENT` removed from docs but still live in enum**
    
    `MISSING_COMPANY_DETAILS_DOCUMENT` is still present in `VerificationErrorType.yaml` (line 6) as a valid enum value, meaning the API can still return a `VerificationError` with that type. However, this PR removes it from the `acceptedDocumentTypes` description — both from the prose list and from the lookup table. Integrators who receive this error will have no documented guidance on which document types to upload to resolve it.
    
    Either `MISSING_COMPANY_DETAILS_DOCUMENT` should be removed from `VerificationErrorType.yaml` (if the error type is truly retired), or its `acceptedDocumentTypes` row should be restored with the new document types that satisfy it.
    
    How can I resolve this? If you propose a fix, please make it concise.

    Fix in Claude Code

Fix All in Claude Code

Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
openapi/components/schemas/verifications/VerificationError.yaml:24-46
**`MISSING_COMPANY_DETAILS_DOCUMENT` removed from docs but still live in enum**

`MISSING_COMPANY_DETAILS_DOCUMENT` is still present in `VerificationErrorType.yaml` (line 6) as a valid enum value, meaning the API can still return a `VerificationError` with that type. However, this PR removes it from the `acceptedDocumentTypes` description — both from the prose list and from the lookup table. Integrators who receive this error will have no documented guidance on which document types to upload to resolve it.

Either `MISSING_COMPANY_DETAILS_DOCUMENT` should be removed from `VerificationErrorType.yaml` (if the error type is truly retired), or its `acceptedDocumentTypes` row should be restored with the new document types that satisfy it.

### Issue 2 of 2
openapi/components/schemas/documents/DocumentType.yaml:29-47
**Enum values orphaned from description categories**

Several enum values remain in the `DocumentType` enum but are no longer listed under any category in the description: `PROOF_OF_ADDRESS`, `INFORMATION_STATEMENT`, `INCUMBENCY_CERTIFICATE`, and `GOOD_STANDING_CERTIFICATE` were all previously categorized and are now uncategorized. API users scanning the description to understand when to use each type will find no guidance for these values. If these types are deprecated and kept only for backwards-compatibility, a note in the description would help integrators avoid using them for new uploads.

Reviews (1): Last reviewed commit: "add document types" | Re-trigger Greptile

Comment thread openapi/components/schemas/documents/DocumentType.yaml
Listing OTHER for both ownership structure and proof of address
would let one generic upload satisfy two distinct KYB categories.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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