simplify identification type enums#341
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✱ Stainless preview buildsThis PR will update the kotlin openapi python typescript ⏳ grid-openapi studio⏳ grid-typescript studio⏳ grid-python studio⏳ grid-kotlin studio⏳ These are partial results; builds are still running. This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThe Confidence Score: 5/5Safe to merge — one minor P2 description staleness, no logic or data issues. The only finding is a P2 description update (the word "document" is no longer accurate now that EIN and NON_TAX_ID are included). All three files are consistently updated and the generated bundles match the source. No correctness or data-integrity issues. openapi/components/schemas/customers/IdentificationType.yaml — description field should be updated to reflect tax-ID framing
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/customers/IdentificationType.yaml | Removes PASSPORT, NATIONAL_ID, DRIVERS_LICENSE, TAX_ID, CPF and adds EIN, NON_TAX_ID; description "Type of personal identification document" is now stale since EIN is a business tax ID |
| openapi.yaml | Generated bundle correctly reflects the source IdentificationType.yaml changes |
| mintlify/openapi.yaml | Mintlify bundle correctly reflects the source IdentificationType.yaml changes |
Sequence Diagram
sequenceDiagram
participant Client
participant GridAPI as Grid API
participant KYC as KYC Engine
Note over Client,KYC: Create/Update Beneficial Owner with IdentificationType
Client->>GridAPI: POST /customers/{id}/beneficial_owners { idType: SSN|ITIN|EIN|NON_TAX_ID }
GridAPI->>KYC: Validate identification
KYC-->>GridAPI: Validation result
GridAPI-->>Client: 200 OK / 422 Unprocessable Entity
Note over Client: Previously accepted (now removed)
Note over Client: PASSPORT, NATIONAL_ID, DRIVERS_LICENSE, TAX_ID, CPF
Note over Client: Now accepted: SSN, ITIN, EIN, NON_TAX_ID
Prompt To Fix All With AI
This is a comment left during a code review.
Path: openapi/components/schemas/customers/IdentificationType.yaml
Line: 7
Comment:
**Description no longer matches the enum values**
The description says "Type of personal identification document," but the new enum values don't fit that framing: `EIN` (Employer Identification Number) is a business/entity tax ID, not a personal document, and `NON_TAX_ID` is a generic catch-all. The enum is now tax-ID-centric rather than document-centric, so the description should be updated.
```suggestion
description: Type of tax identification number
```
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "simplify identification type enums" | Re-trigger Greptile
| - CPF | ||
| - EIN | ||
| - NON_TAX_ID | ||
| description: Type of personal identification document |
There was a problem hiding this comment.
Description no longer matches the enum values
The description says "Type of personal identification document," but the new enum values don't fit that framing: EIN (Employer Identification Number) is a business/entity tax ID, not a personal document, and NON_TAX_ID is a generic catch-all. The enum is now tax-ID-centric rather than document-centric, so the description should be updated.
| description: Type of personal identification document | |
| description: Type of tax identification number |
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/customers/IdentificationType.yaml
Line: 7
Comment:
**Description no longer matches the enum values**
The description says "Type of personal identification document," but the new enum values don't fit that framing: `EIN` (Employer Identification Number) is a business/entity tax ID, not a personal document, and `NON_TAX_ID` is a generic catch-all. The enum is now tax-ID-centric rather than document-centric, so the description should be updated.
```suggestion
description: Type of tax identification number
```
How can I resolve this? If you propose a fix, please make it concise.
We already collect passport/DL in document upload. We can simplify this text input to be focused on tax identifiers instead