lithic 0.20.0 → 0.22.0

data/lib/lithic/models/account_holder_updated_webhook_event.rb

@@ -133,7 +133,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::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address, nil]
             optional :address,
@@ -202,51 +203,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::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::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
 
@@ -254,7 +272,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::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address, nil]
             optional :address,
@@ -332,51 +351,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::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::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
         end
@@ -457,7 +493,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::AccountHolderUpdatedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address, nil]
             optional :address,
@@ -529,51 +566,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::AccountHolderUpdatedWebhookEvent::KYCPayload::UpdateRequest::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
         end

data/lib/lithic/models/account_holders/account_holder_entity.rb

@@ -103,33 +103,49 @@ 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 address2
+          #   Unit or apartment number (if applicable).
+          #
+          #   @return [String, nil]
+          optional :address2, 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.
+          #   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 :postal_code, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
           # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          #   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:
           #
-          #   @return [String]
-          required :state, String
-
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          #   - `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::AccountHolders::AccountHolderEntity::Address} for more details.
           #
@@ -139,13 +155,13 @@ module Lithic
           #
           #   @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
 
         # The status of the entity

data/lib/lithic/models/account_holders/entity_create_params.rb

@@ -15,7 +15,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::AccountHolders::EntityCreateParams::Address]
         required :address, -> { Lithic::AccountHolders::EntityCreateParams::Address }
@@ -104,50 +105,67 @@ 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 address2
+          #   Unit or apartment number (if applicable).
+          #
+          #   @return [String, nil]
+          optional :address2, 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.
+          #   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 :postal_code, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
           # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          #   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:
           #
-          #   @return [String]
-          required :state, String
-
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          #   - `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::AccountHolders::EntityCreateParams::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
     end

data/lib/lithic/models/address.rb

@@ -17,34 +17,48 @@ module Lithic
 
       # @!attribute country
       #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
-      #   format. Only USA is currently supported for all workflows. KYC_EXEMPT supports
-      #   CAN additionally.
+      #   format. The KYB_DELEGATED and KYC_EXEMPT workflows support all countries except
+      #   BLR, CUB, IRN, PRK, RUS, SDN, SYR, and UKR. Other workflows support USA only.
       #
       #   @return [String]
       required :country, String
 
+      # @!attribute address2
+      #   Unit or apartment number (if applicable).
+      #
+      #   @return [String, nil]
+      optional :address2, String
+
       # @!attribute postal_code
-      #   Valid postal code. USA postal codes (ZIP codes) are supported, entered as a
-      #   five-digit postal code or nine-digit postal code (ZIP+4) using the format
-      #   12345-1234. KYC_EXEMPT supports Canadian postal codes.
+      #   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 :postal_code, String
+      #   @return [String, nil]
+      optional :postal_code, String, nil?: true
 
       # @!attribute state
-      #   Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
-      #   two-character format. KYC_EXEMPT supports Canadian province codes.
+      #   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:
       #
-      #   @return [String]
-      required :state, String
-
-      # @!attribute address2
-      #   Unit or apartment number (if applicable).
+      #   - `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::Address}
       #   for more details.
       #
@@ -54,11 +68,11 @@ module Lithic
       #
       #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
       #
-      #   @param postal_code [String] Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five
+      #   @param address2 [String] Unit or apartment number (if applicable).
       #
-      #   @param state [String] Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
+      #   @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
 end

data/lib/lithic/models/address_update.rb

@@ -22,25 +22,41 @@ module Lithic
       optional :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, nil]
       optional :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.
+      #   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, nil]
-      optional :postal_code, String
+      optional :postal_code, String, nil?: true
 
       # @!attribute state
-      #   Valid state code. Only USA state codes are currently supported, entered in
-      #   uppercase ISO 3166-2 two-character format.
+      #   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 :state, String
+      optional :state, String, nil?: true
 
       # @!method initialize(address1: nil, address2: nil, city: nil, country: nil, postal_code: nil, state: nil)
       #   Some parameter documentations has been truncated, see
@@ -52,11 +68,11 @@ module Lithic
       #
       #   @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 postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
       #
-      #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+      #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
     end
   end
 end