add document types#441
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview buildsThis PR will update the kotlin openapi python typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-kotlin studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-python studio · code · diff
✅ grid-typescript studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThis PR expands the
Confidence Score: 3/5Needs 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.
|
| 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
Comments Outside Diff (1)
-
openapi/components/schemas/verifications/VerificationError.yaml, line 24-46 (link)MISSING_COMPANY_DETAILS_DOCUMENTremoved from docs but still live in enumMISSING_COMPANY_DETAILS_DOCUMENTis still present inVerificationErrorType.yaml(line 6) as a valid enum value, meaning the API can still return aVerificationErrorwith that type. However, this PR removes it from theacceptedDocumentTypesdescription — 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_DOCUMENTshould be removed fromVerificationErrorType.yaml(if the error type is truly retired), or itsacceptedDocumentTypesrow 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.
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
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>

No description provided.