diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index ea671da1..bb23901e 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -394,6 +394,17 @@ paths: birthDate: '1988-05-22' nationality: MX phoneNumber: '+525512345678' + individualCustomerCurrenciesOnly: + summary: Create an individual customer with currencies and no region + value: + customerType: INDIVIDUAL + platformCustomerId: ind-4c2e8b15 + currencies: + - BRL + fullName: Ana Oliveira + birthDate: '1992-11-03' + nationality: BR + phoneNumber: '+5511987654321' businessCustomer: summary: Create a business customer value: @@ -12843,13 +12854,13 @@ components: $ref: '#/components/schemas/CustomerType' region: type: string - description: Country code (ISO 3166-1 alpha-2) representing the customer's regional identity. This determines the regulatory jurisdiction and KYC requirements for the customer. Required if the customer will use currencies with different KYC requirements across regions. A customer with accounts in multiple regions should be registered as separate customers. This field is immutable after creation. + description: Country code (ISO 3166-1 alpha-2) for the customer's region. Optional — send it only when the same currency is offered in more than one of your regions, to pick the one that applies to this customer. example: US currencies: type: array items: type: string - description: List of currency codes the customer will use (ISO 4217 for fiat, e.g. "USD", "EUR"; tickers for crypto, e.g. "BTC", "USDC"). Required if the customer will use more than one sending currency, since the correct currencies cannot always be inferred. If not provided, currencies will be inferred from the customer's region. Some currency combinations may require separate customers — if so, the request will be rejected with details. + description: Currency codes the customer will use — ISO 4217 for fiat, tickers for crypto (e.g. "USDC"). Optional — send them if your platform supports more than one currency, so we know which ones this customer needs. Some combinations require separate customers. example: - USD - USDC diff --git a/openapi.yaml b/openapi.yaml index ea671da1..bb23901e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -394,6 +394,17 @@ paths: birthDate: '1988-05-22' nationality: MX phoneNumber: '+525512345678' + individualCustomerCurrenciesOnly: + summary: Create an individual customer with currencies and no region + value: + customerType: INDIVIDUAL + platformCustomerId: ind-4c2e8b15 + currencies: + - BRL + fullName: Ana Oliveira + birthDate: '1992-11-03' + nationality: BR + phoneNumber: '+5511987654321' businessCustomer: summary: Create a business customer value: @@ -12843,13 +12854,13 @@ components: $ref: '#/components/schemas/CustomerType' region: type: string - description: Country code (ISO 3166-1 alpha-2) representing the customer's regional identity. This determines the regulatory jurisdiction and KYC requirements for the customer. Required if the customer will use currencies with different KYC requirements across regions. A customer with accounts in multiple regions should be registered as separate customers. This field is immutable after creation. + description: Country code (ISO 3166-1 alpha-2) for the customer's region. Optional — send it only when the same currency is offered in more than one of your regions, to pick the one that applies to this customer. example: US currencies: type: array items: type: string - description: List of currency codes the customer will use (ISO 4217 for fiat, e.g. "USD", "EUR"; tickers for crypto, e.g. "BTC", "USDC"). Required if the customer will use more than one sending currency, since the correct currencies cannot always be inferred. If not provided, currencies will be inferred from the customer's region. Some currency combinations may require separate customers — if so, the request will be rejected with details. + description: Currency codes the customer will use — ISO 4217 for fiat, tickers for crypto (e.g. "USDC"). Optional — send them if your platform supports more than one currency, so we know which ones this customer needs. Some combinations require separate customers. example: - USD - USDC diff --git a/openapi/components/schemas/customers/CustomerCreateRequest.yaml b/openapi/components/schemas/customers/CustomerCreateRequest.yaml index 47d1e076..f2ccb2e0 100644 --- a/openapi/components/schemas/customers/CustomerCreateRequest.yaml +++ b/openapi/components/schemas/customers/CustomerCreateRequest.yaml @@ -11,23 +11,19 @@ properties: region: type: string description: >- - Country code (ISO 3166-1 alpha-2) representing the customer's regional identity. - This determines the regulatory jurisdiction and KYC requirements for the customer. - Required if the customer will use currencies with different KYC requirements across - regions. A customer with accounts in multiple regions should be registered as separate - customers. This field is immutable after creation. + Country code (ISO 3166-1 alpha-2) for the customer's region. Optional — send + it only when the same currency is offered in more than one of your regions, + to pick the one that applies to this customer. example: US currencies: type: array items: type: string description: >- - List of currency codes the customer will use (ISO 4217 for fiat, e.g. "USD", "EUR"; - tickers for crypto, e.g. "BTC", "USDC"). Required if the customer will use more than - one sending currency, since the correct currencies cannot always be inferred. If not - provided, currencies will be inferred from the customer's region. Some currency - combinations may require separate customers — if so, the request will be rejected - with details. + Currency codes the customer will use — ISO 4217 for fiat, tickers for crypto + (e.g. "USDC"). Optional — send them if your platform supports more than one + currency, so we know which ones this customer needs. Some combinations + require separate customers. example: - USD - USDC diff --git a/openapi/paths/customers/customers.yaml b/openapi/paths/customers/customers.yaml index 4f6d9bd9..e2ba05a3 100644 --- a/openapi/paths/customers/customers.yaml +++ b/openapi/paths/customers/customers.yaml @@ -39,6 +39,17 @@ post: birthDate: '1988-05-22' nationality: MX phoneNumber: '+525512345678' + individualCustomerCurrenciesOnly: + summary: Create an individual customer with currencies and no region + value: + customerType: INDIVIDUAL + platformCustomerId: ind-4c2e8b15 + currencies: + - BRL + fullName: Ana Oliveira + birthDate: '1992-11-03' + nationality: BR + phoneNumber: '+5511987654321' businessCustomer: summary: Create a business customer value: