From e3ce7b6c2f4ab5f451fa1ff54b94703340216446 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <41898282+claude[bot]@users.noreply.github.com> Date: Fri, 3 Jul 2026 09:10:22 +0000 Subject: [PATCH] docs: document idType/identifier fields for US individual customers Add documentation for the new idType and identifier fields added in a2e2b804. These fields are required for onboarding US individual account holders (SSN or ITIN). - Add to OpenAPI example for individual customer creation - Document in customers.mdx snippet alongside other individual fields Co-Authored-By: Claude Opus 4.5 --- mintlify/openapi.yaml | 2 ++ mintlify/snippets/creating-customers/customers.mdx | 1 + openapi.yaml | 2 ++ openapi/paths/customers/customers.yaml | 2 ++ 4 files changed, 7 insertions(+) diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index 9beb0ec97..f65cc3db9 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -370,6 +370,8 @@ paths: nationality: US email: jane.smith@example.com phoneNumber: '+14155551234' + idType: SSN + identifier: 123-45-6789 individualCustomerInferred: summary: Create an individual customer with inferred currencies value: diff --git a/mintlify/snippets/creating-customers/customers.mdx b/mintlify/snippets/creating-customers/customers.mdx index 0d6c4deb3..d9b7b5843 100644 --- a/mintlify/snippets/creating-customers/customers.mdx +++ b/mintlify/snippets/creating-customers/customers.mdx @@ -27,6 +27,7 @@ export const Customers = ({ individualEnabled = true, businessEnabled = true, um - Full name - Date of birth (YYYY-MM-DD format) - Physical address (including country, state, city, postalCode) + - Tax identification (`idType` and `identifier`) — required for US account holders. Accepted types are `SSN` (Social Security Number) and `ITIN` (Individual Taxpayer Identification Number). The `identifier` field is write-only and never returned in responses. **Note:** Check the `providerRequiredCustomerFields` for each relevant currency in your platform's configuration to determine which of these fields are strictly mandatory at creation/update time for that customer to transact in those currencies. diff --git a/openapi.yaml b/openapi.yaml index 9beb0ec97..f65cc3db9 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -370,6 +370,8 @@ paths: nationality: US email: jane.smith@example.com phoneNumber: '+14155551234' + idType: SSN + identifier: 123-45-6789 individualCustomerInferred: summary: Create an individual customer with inferred currencies value: diff --git a/openapi/paths/customers/customers.yaml b/openapi/paths/customers/customers.yaml index a87e24512..90ced9e52 100644 --- a/openapi/paths/customers/customers.yaml +++ b/openapi/paths/customers/customers.yaml @@ -29,6 +29,8 @@ post: nationality: US email: jane.smith@example.com phoneNumber: '+14155551234' + idType: SSN + identifier: '123-45-6789' individualCustomerInferred: summary: Create an individual customer with inferred currencies value: