Unify individual customer identification on idType/identifier/countryOfIssuance - #832
Unify individual customer identification on idType/identifier/countryOfIssuance#832ls-bolt[bot] wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-typescript studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-go studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-python studio · code · diff
✅ grid-php studio · code · diff
✅ grid-cli studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
…OfIssuance (#836) ## Summary Individual customers accepted two interchangeable identification vocabularies: `taxIdType` / `taxIdentifier` / `taxIdCountryOfIssuance`, and `idType` / `identifier`. Beneficial owners only ever had `idType` / `identifier` / `countryOfIssuance`. This drops the `taxId*` set so both resources speak one vocabulary. | Removed | Replacement | |---|---| | `taxIdType` | `idType` | | `taxIdentifier` | `identifier` | | `taxIdCountryOfIssuance` | `countryOfIssuance` | `identifier` now lives on the shared `IndividualCustomerFields` as `writeOnly`, which lets `IndividualCustomerCreateRequest` drop its duplicate declaration. `taxIdentifier` was not write-only, so the schema advertised a response field that is never populated; the unified field fixes that. Other `taxId`-prefixed fields are untouched — `BusinessInfo.taxId` (EIN), `BrlAccountInfoBase.taxId` and `BusinessBeneficiary.taxId` (CPF/CNPJ) are a different concept with no `idType` counterpart. No `info.version` bump: these fields have no integrator on them yet, and a bump would mean cutting a new dated `servers.url` path for a pre-adoption cleanup. ## Changes - `openapi/components/schemas/customers/IndividualCustomerFields.yaml` — rename the three properties, mark `identifier` write-only - `openapi/components/schemas/customers/IndividualCustomerCreateRequest.yaml` — drop the now-duplicate `idType` / `identifier` block - `openapi/components/schemas/errors/FieldError.yaml` — example field name - `mintlify/snippets/sandbox-verification.mdx` — requirement prose, the `RESOLVE_ERRORS` sample, and the PATCH example - `openapi.yaml`, `mintlify/openapi.yaml` — `make build` output ## Test plan - `make build` — exit 0, both bundles regenerated - `make lint` — exit 0, 0 errors; warning/info counts unchanged from `main` (658 problems, all pre-existing) - `grep -rn "taxIdType\|taxIdentifier\|taxIdCountryOfIssuance" openapi/ mintlify/` — no matches The consuming server change lands separately in webdev, which regenerates its Python models from this bundle. Merge this first. Requested by @akanter Original PR: #832

Summary
Individual customers accepted two interchangeable identification vocabularies:
taxIdType/taxIdentifier/taxIdCountryOfIssuance, andidType/identifier. Beneficial owners only ever hadidType/identifier/countryOfIssuance. This drops thetaxId*set so both resources speak one vocabulary.taxIdTypeidTypetaxIdentifieridentifiertaxIdCountryOfIssuancecountryOfIssuanceidentifiernow lives on the sharedIndividualCustomerFieldsaswriteOnly, which letsIndividualCustomerCreateRequestdrop its duplicate declaration.taxIdentifierwas not write-only, so the schema advertised a response field that is never populated; the unified field fixes that.Other
taxId-prefixed fields are untouched —BusinessInfo.taxId(EIN),BrlAccountInfoBase.taxIdandBusinessBeneficiary.taxId(CPF/CNPJ) are a different concept with noidTypecounterpart.No
info.versionbump: these fields have no integrator on them yet, and a bump would mean cutting a new datedservers.urlpath for a pre-adoption cleanup.Changes
openapi/components/schemas/customers/IndividualCustomerFields.yaml— rename the three properties, markidentifierwrite-onlyopenapi/components/schemas/customers/IndividualCustomerCreateRequest.yaml— drop the now-duplicateidType/identifierblockopenapi/components/schemas/errors/FieldError.yaml— example field namemintlify/snippets/sandbox-verification.mdx— requirement prose, theRESOLVE_ERRORSsample, and the PATCH exampleopenapi.yaml,mintlify/openapi.yaml—make buildoutputTest plan
make build— exit 0, both bundles regeneratedmake lint— exit 0, 0 errors; warning/info counts unchanged frommain(658 problems, all pre-existing)grep -rn "taxIdType\|taxIdentifier\|taxIdCountryOfIssuance" openapi/ mintlify/— no matchesThe consuming server change lands separately in webdev, which regenerates its Python models from this bundle. Merge this first.
Requested by @akanter