lithic 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a1dad385b89d74fc7b9228fc05beafec83f75a70f844981c069f5363224516c
-  data.tar.gz: ebf7bf2cb414e22297cec903a453e582a65ae88bcc9452a7151905d261504332
+  metadata.gz: 1d5394fbf93d5fe79485f48eeee1e627eca7c52a58f140b47c7d060fe16dd59b
+  data.tar.gz: a970af229514a369b29f77419d940d3ba75d3981b914fbcbac192f877b26062d
 SHA512:
-  metadata.gz: e8c7901fb8cfcddae62cf0652149ce81862fb297ac35ee9e4494bdfee61a455feaa15821eeceaa13e41effba6ebfc3f87a6a10a9713d8110de617c5eff7252fe
-  data.tar.gz: 9e5d08fa9e5d110aab84ffe6e9afac0e093db30b2cdf41a582995669c342c94dffe7134d8cac89b96a975fa1ebe6f14d8e303e7f6a0bae8b6a393cb5ca5a3777
+  metadata.gz: fa85dffbcc1a77f79a0b259a7d8c25b1cdbec7a02f7116b93687a197986c986d08eff4811c465ed5856f01bdc336aeeccdf18c352fbdb2a2bc0ed7492e8359ed
+  data.tar.gz: 5e3bed3eb70b84aa9496b568729b72cf27fcf56cd798135026b6580737973fe6e0e8c07cc106f6dc531b12bee7c3b5eb2e8b7bfb9cef1b213bb5c6c5d3de8701

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## [0.22.0](https://github.com/lithic-com/lithic-ruby/compare/v0.21.0...v0.22.0) (2026-10-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** the CONDITIONAL_BLOCK rule type and the ConditionalBlockParameters model are removed. All rules are now CONDITIONAL_ACTION.
+
+### Features
+
+* **api:** accept billing_currency and settlement_currency on transaction simulation endpoints ([428ae58](https://github.com/lithic-com/lithic-ruby/commit/428ae5843e4ad441e828dcb7f73b889f8756d887))
+* **api:** add entities to auth rules and an endpoint to update a rule's entities incrementally ([462b161](https://github.com/lithic-com/lithic-ruby/commit/462b161da24cb01374ae438d5217208ccc652a79))
+* **api:** add installment plan statement endpoints to financial accounts ([e94582e](https://github.com/lithic-com/lithic-ruby/commit/e94582ea1ea6e30db808bd62b2952dac9b3fd3ad))
+* **api:** add payment-only allocation breakdown to the loan tape ([625d033](https://github.com/lithic-com/lithic-ruby/commit/625d033aaec889eef435909baa44f3efabc17e50))
+* **api:** add tags to card create and update parameters and card responses ([31f4225](https://github.com/lithic-com/lithic-ruby/commit/31f42251508fff2120b90678891414285e34c5ab))
+* **api:** add tags to the card object in auth stream access requests ([5c9677a](https://github.com/lithic-com/lithic-ruby/commit/5c9677ade53fe5d0248a1cd6e5c109033388fb07))
+* **api:** expose the full conditional attribute set for authorization rules ([2ab59fc](https://github.com/lithic-com/lithic-ruby/commit/2ab59fc2d2113eba31919f86dd5cbff5e72d09bf))
+* **api:** remove CONDITIONAL_BLOCK from authorization rules ([7a4a3d3](https://github.com/lithic-com/lithic-ruby/commit/7a4a3d3ddf06d7f2139e38bde4c8f68e0f9e827e))
+* **api:** support international addresses and address2 for KYB_DELEGATED and KYC_EXEMPT workflows ([cd0721a](https://github.com/lithic-com/lithic-ruby/commit/cd0721a5e04383773baa69cb06f07d83ec037ef8))
+
+## 0.21.0 (2026-09-18)
+
+Full Changelog: [v0.20.0...v0.21.0](https://github.com/lithic-com/lithic-ruby/compare/v0.20.0...v0.21.0)
+
+### Features
+
+* [CARDS-5174] Add reiusse/renew 409 error ([2fc8f3b](https://github.com/lithic-com/lithic-ruby/commit/2fc8f3b93ff2e392d8eda8e343d21e423c214191))
+* [TRE-14464] Update /retry payments endpoint to accept method ([6031d67](https://github.com/lithic-com/lithic-ruby/commit/6031d6794afd8c3a4b121cf2f7368e0ac40867c0))
+* [TRE-14524] Add Open to buy API spec ([bdf043e](https://github.com/lithic-com/lithic-ruby/commit/bdf043e53ac45964c091134b25fb7a3023948397))
+* Add missing blockchain/stablecoin endpoints to the spec ([3e8c0dc](https://github.com/lithic-com/lithic-ruby/commit/3e8c0dcdaa7169ba0a47bea4493e71d778af8853))
+* **api:** add EXTERNAL_STABLECOIN category and events to payment resources ([518aebb](https://github.com/lithic-com/lithic-ruby/commit/518aebb0cf94cbc0b1ca1ef85a94a71c5bf1983e))
+* **api:** add FEE/FEE_REVERSAL to financial_event, statement_line_items, management_operation ([04690f1](https://github.com/lithic-com/lithic-ruby/commit/04690f1542cb3f213da8695507a371c4f0a5aed4))
+* **api:** add OTHER enum value to auth_rules type field ([1bb4cc8](https://github.com/lithic-com/lithic-ruby/commit/1bb4cc80ab6e025ebf0d6fcdd88c5b62cbb602a0))
+* **api:** add psd2_context field to three_ds_authentication ([19e526e](https://github.com/lithic-com/lithic-ruby/commit/19e526e916227881e91ac1dac42e75d86132451e))
+* **api:** add retrieve/list methods to financial_accounts installment_plans ([13b25f3](https://github.com/lithic-com/lithic-ruby/commit/13b25f3cef123eedc918ab5730aacb64114175fe))
+* **api:** add STABLECOIN_REVIEWED event type to payment simulate action ([766c658](https://github.com/lithic-com/lithic-ruby/commit/766c658645a79accfca85707ce6d5c087d93959e))
+* AUTH-3759: Add DECLINE_SCA_REQUIRED and SCA_REQUIRED enum entries ([e784b27](https://github.com/lithic-com/lithic-ruby/commit/e784b275c2690eb0d2ab4a36a3ee9f5af2f79b0b))
+* TRE-14349: add installment plan management operation event types ([bd71bde](https://github.com/lithic-com/lithic-ruby/commit/bd71bde5d20641e236b5b2e95908293bf0ef48e9))
+* TRE-14429: Document the stablecoin payments endpoint ([050c7bd](https://github.com/lithic-com/lithic-ruby/commit/050c7bdd679e3c090c6e1819c0aa3405e3cbfc0c))
+
+
+### Documentation
+
+* Document the card.pin_updated webhook ([b96e92e](https://github.com/lithic-com/lithic-ruby/commit/b96e92e36fa4ae4dab543d1cc639d807f810b967))
+
 ## 0.20.0 (2026-08-31)
 
 Full Changelog: [v0.19.0...v0.20.0](https://github.com/lithic-com/lithic-ruby/compare/v0.19.0...v0.20.0)

data/README.md

@@ -2,15 +2,6 @@
 
 The Lithic Ruby library provides convenient access to the Lithic REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/lithic-com/lithic-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
-## MCP Server
-
-Use the Lithic MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
-
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=lithic-mcp&config=eyJuYW1lIjoibGl0aGljLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL2xpdGhpYy5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LWxpdGhpYy1hcGkta2V5IjoiTXkgTGl0aGljIEFQSSBLZXkifX0)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22lithic-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Flithic.stlmcp.com%22%2C%22headers%22%3A%7B%22x-lithic-api-key%22%3A%22My%20Lithic%20API%20Key%22%7D%7D)
-
-> Note: You may need to set environment variables in your MCP client.
-
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/lithic).
@@ -24,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.20.0"
+gem "lithic", "~> 0.22.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/lithic/internal/type/union.rb

@@ -6,14 +6,28 @@ module Lithic
       # @api private
       #
       # @example
-      #   # `case_transaction` is a `Lithic::TransactionMonitoring::CaseTransaction`
-      #   case case_transaction
-      #   when Lithic::TransactionMonitoring::CaseTransaction::CardCaseTransaction
-      #     puts(case_transaction.token)
-      #   when Lithic::TransactionMonitoring::CaseTransaction::PaymentCaseTransaction
-      #     puts(case_transaction.added_at)
+      #   # `auth_rule_entity` is a `Lithic::AuthRules::AuthRuleEntity`
+      #   case auth_rule_entity
+      #   when Lithic::AuthRules::AuthRuleEntity::Program
+      #     puts(auth_rule_entity.type)
+      #   when Lithic::AuthRules::AuthRuleEntity::Card
+      #     puts(auth_rule_entity.token)
+      #   when Lithic::AuthRules::AuthRuleEntity::Account
+      #     puts(auth_rule_entity.token)
       #   else
-      #     puts(case_transaction)
+      #     puts(auth_rule_entity)
+      #   end
+      #
+      # @example
+      #   case auth_rule_entity
+      #   in {type: :PROGRAM}
+      #     # ...
+      #   in {type: :CARD, token: token}
+      #     puts(token)
+      #   in {type: :ACCOUNT, token: token}
+      #     puts(token)
+      #   else
+      #     puts(auth_rule_entity)
       #   end
       module Union
         include Lithic::Internal::Type::Converter

data/lib/lithic/models/account_activity_list_params.rb

@@ -123,6 +123,7 @@ module Lithic
         EXTERNAL_CHECK = :EXTERNAL_CHECK
         EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
         EXTERNAL_RTP = :EXTERNAL_RTP
+        EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
         EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
         EXTERNAL_WIRE = :EXTERNAL_WIRE
         MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT

data/lib/lithic/models/account_activity_list_response.rb

@@ -162,6 +162,7 @@ module Lithic
           EXTERNAL_CHECK = :EXTERNAL_CHECK
           EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
           EXTERNAL_RTP = :EXTERNAL_RTP
+          EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
           EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
           EXTERNAL_WIRE = :EXTERNAL_WIRE
           MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT

data/lib/lithic/models/account_activity_retrieve_transaction_response.rb

@@ -165,6 +165,7 @@ module Lithic
           EXTERNAL_CHECK = :EXTERNAL_CHECK
           EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
           EXTERNAL_RTP = :EXTERNAL_RTP
+          EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
           EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
           EXTERNAL_WIRE = :EXTERNAL_WIRE
           MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT

data/lib/lithic/models/account_holder_create_params.rb

@@ -202,7 +202,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::Address, nil]
             optional :address, -> { Lithic::Address }
@@ -274,7 +275,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::Address, nil]
             optional :address, -> { Lithic::Address }

data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb

@@ -216,7 +216,8 @@ module Lithic
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        #   and KYC workflows.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address, nil]
         optional :address,
@@ -285,51 +286,68 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address}
           #   for more details.
           #
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @param address1 [String] Valid deliverable address (no PO boxes).
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end
 
@@ -337,7 +355,8 @@ module Lithic
       class ControlPerson < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        #   and KYC workflows.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address, nil]
         optional :address,
@@ -418,51 +437,68 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address}
           #   for more details.
           #
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @param address1 [String] Valid deliverable address (no PO boxes).
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end
 
@@ -484,7 +520,8 @@ module Lithic
       class Individual < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        #   and KYC workflows.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address, nil]
         optional :address,
@@ -556,51 +593,68 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address}
           #   for more details.
           #
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @param address1 [String] Valid deliverable address (no PO boxes).
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end
 

data/lib/lithic/models/account_holder_update_params.rb

@@ -129,7 +129,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::AddressUpdate, nil]
             optional :address, -> { Lithic::AddressUpdate }
@@ -282,7 +283,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::AddressUpdate, nil]
             optional :address, -> { Lithic::AddressUpdate }
@@ -397,7 +399,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::AddressUpdate, nil]
             optional :address, -> { Lithic::AddressUpdate }