checkout_sdk 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bbc37199396a629e90ac6e153ee17fd57ae6d8f66b378a0bc43b71130b9fa2e
-  data.tar.gz: 04771c9af135d78ef7c4392aac336f94573c17edc95cd10944ec0b2dce899b68
+  metadata.gz: 8b7aae1c3707fc4f1c0b73f5ca4cecceb1eaa052d54eabf28957746c8510871b
+  data.tar.gz: d5fe7d069ed73f21ce0735c812628264bb6c4032f4665bef2caadb62f1dc64f0
 SHA512:
-  metadata.gz: e96638baf4e1087672db55136ed636a93e3f492d073f007370b1f5dbf0b808327e0c12278a0b7167be0009f8e2e74007c85b8607eb1f94518600bfdc83333bef
-  data.tar.gz: 5fa519ec4adc2cbe5965c00cc646630bfef486035c66b9ec6041f1c0822d5d4b555dd5e3c0710fbe34d4a46032a1bb637ae631539dabf97a2727b3a139d08aec
+  metadata.gz: 9090c0826b9a456ca253ff600da4074d43ef57ce214d864c7d85f74ba040f30d1542705fd6834d0dde2264f12bb66415762af749379529cf0256cd41daf5ab66
+  data.tar.gz: 654a11201af0922d2949831c9d4db6436c7badd6b858e5776dc54a109abf169872960f72fa82579c663a39e22891a0d9df09a94e614e26a95b48d0612c47769c

data/lib/checkout_sdk/accounts/accounts.rb

@@ -69,3 +69,14 @@ require 'checkout_sdk/accounts/rolling_reserve_rule'
 require 'checkout_sdk/accounts/reserve_rule_update_request'
 require 'checkout_sdk/accounts/reserve_rule_create_request'
 require 'checkout_sdk/accounts/entity_files_request'
+require 'checkout_sdk/accounts/agreed_terms'
+require 'checkout_sdk/accounts/processing_details_ach'
+require 'checkout_sdk/accounts/processing_details_payments'
+require 'checkout_sdk/accounts/company_position'
+require 'checkout_sdk/accounts/entity_roles'
+require 'checkout_sdk/accounts/national_id_type'
+require 'checkout_sdk/accounts/citizenship'
+require 'checkout_sdk/accounts/representative_individual'
+require 'checkout_sdk/accounts/financial_statements'
+require 'checkout_sdk/accounts/financial_statements_type'
+require 'checkout_sdk/accounts/articles_of_association'

data/lib/checkout_sdk/accounts/accounts_client.rb

@@ -14,6 +14,7 @@ module CheckoutSdk
       REQUIREMENTS = 'requirements'
       RESERVE_RULES = 'reserve-rules'
       MEMBERS = 'members'
+      DEFAULT_SCHEMA_VERSION = '3.0'
       private_constant :ACCOUNTS, :ENTITIES, :INSTRUMENT, :PAYOUT_SCHEDULE, :FILES, :PAYMENT_INSTRUMENTS,
                        :REQUIREMENTS, :RESERVE_RULES, :MEMBERS
 
@@ -26,19 +27,25 @@ module CheckoutSdk
       end
 
       # @param [Hash, OnboardEntity] entity_request
-      def create_entity(entity_request)
-        api_client.invoke_post(build_path(ACCOUNTS, ENTITIES), sdk_authorization, entity_request)
+      # @param [String] schema_version Accounts API schema version negotiated via the Accept header.
+      def create_entity(entity_request, schema_version = DEFAULT_SCHEMA_VERSION)
+        api_client.invoke_post(build_path(ACCOUNTS, ENTITIES), sdk_authorization, entity_request, nil,
+                               build_schema_version_headers(schema_version))
       end
 
       # @param [String] entity_id
-      def get_entity(entity_id)
-        api_client.invoke_get(build_path(ACCOUNTS, ENTITIES, entity_id), sdk_authorization)
+      # @param [String] schema_version Accounts API schema version negotiated via the Accept header.
+      def get_entity(entity_id, schema_version = DEFAULT_SCHEMA_VERSION)
+        api_client.invoke_get(build_path(ACCOUNTS, ENTITIES, entity_id), sdk_authorization, nil,
+                              build_schema_version_headers(schema_version))
       end
 
       # @param [String] entity_id
       # @param [Hash, OnboardEntity] entity_request
-      def update_entity(entity_id, entity_request)
-        api_client.invoke_put(build_path(ACCOUNTS, ENTITIES, entity_id), sdk_authorization, entity_request)
+      # @param [String] schema_version Accounts API schema version negotiated via the Accept header.
+      def update_entity(entity_id, entity_request, schema_version = DEFAULT_SCHEMA_VERSION)
+        api_client.invoke_put(build_path(ACCOUNTS, ENTITIES, entity_id), sdk_authorization, entity_request,
+                              build_schema_version_headers(schema_version))
       end
 
       # @deprecated Please use {#add_payment_instrument} instead
@@ -100,10 +107,13 @@ module CheckoutSdk
 
       # Retrieve the list of pending requirements that a sub-entity must resolve.
       # @param [String] entity_id
-      def get_entity_requirements(entity_id)
+      # @param [String] schema_version Accounts API schema version negotiated via the Accept header.
+      def get_entity_requirements(entity_id, schema_version = DEFAULT_SCHEMA_VERSION)
         api_client.invoke_get(
           build_path(ACCOUNTS, ENTITIES, entity_id, REQUIREMENTS),
-          sdk_authorization
+          sdk_authorization,
+          nil,
+          build_schema_version_headers(schema_version)
         )
       end
 
@@ -226,6 +236,17 @@ module CheckoutSdk
           sdk_authorization
         )
       end
+
+      private
+
+      # Builds the versioned Accept header for Accounts onboarding operations.
+      # @param [String] schema_version
+      # @return [CheckoutSdk::Common::Headers]
+      def build_schema_version_headers(schema_version)
+        headers = CheckoutSdk::Common::Headers.new
+        headers.accept = "application/json;schema_version=#{schema_version}"
+        headers
+      end
     end
   end
 end

data/lib/checkout_sdk/accounts/agreed_terms.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The terms of service the sub-entity agreed to (Accounts API v3.0, SaaS onboarding).
+    # @!attribute date
+    #   @return [String] Date and time the terms were agreed (RFC 3339 / ISO 8601).
+    # @!attribute ip_address
+    #   @return [String] IP address (IPv4 or IPv6) of the person at the time they agreed.
+    # @!attribute name
+    #   @return [String] First and last name of the person who agreed to the terms.
+    # @!attribute email
+    #   @return [String] Email address of the person who agreed to the terms.
+    # @!attribute version
+    #   @return [String] Identifier of the terms version that was agreed.
+    class AgreedTerms
+      attr_accessor :date,
+                    :ip_address,
+                    :name,
+                    :email,
+                    :version
+    end
+  end
+end

data/lib/checkout_sdk/accounts/articles_of_association.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [ArticlesOfAssociationType]
+    # @!attribute front
+    #   @return [String]
+    class ArticlesOfAssociation
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/business_type.rb

@@ -3,13 +3,25 @@
 module CheckoutSdk
   module Accounts
     module BusinessType
+      INDIVIDUAL_OR_SOLE_PROPRIETORSHIP = 'individual_or_sole_proprietorship'
       GENERAL_PARTNERSHIP = 'general_partnership'
       LIMITED_PARTNERSHIP = 'limited_partnership'
+      SCOTTISH_LIMITED_PARTNERSHIP = 'scottish_limited_partnership'
       PUBLIC_LIMITED_COMPANY = 'public_limited_company'
       LIMITED_COMPANY = 'limited_company'
+      LIMITED_LIABILITY_CORPORATION = 'limited_liability_corporation'
+      PRIVATE_CORPORATION = 'private_corporation'
+      PUBLICLY_TRADED_CORPORATION = 'publicly_traded_corporation'
       PROFESSIONAL_ASSOCIATION = 'professional_association'
       UNINCORPORATED_ASSOCIATION = 'unincorporated_association'
       AUTO_ENTREPRENEUR = 'auto_entrepreneur'
+      GOVERNMENT_AGENCY = 'government_agency'
+      NON_PROFIT_ENTITY = 'non_profit_entity'
+      TRUST = 'trust'
+      CLUB_OR_SOCIETY = 'club_or_society'
+      REGULATED_FINANCIAL_INSTITUTION = 'regulated_financial_institution'
+      CFTC_REGISTERED_ENTITY = 'cftc_registered_entity'
+      SEC_REGISTERED_ENTITY = 'sec_registered_entity'
     end
   end
 end

data/lib/checkout_sdk/accounts/citizenship.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # A citizenship or legal status held by a company representative (Accounts API v3.0).
+    # @!attribute type
+    #   @return [String] The type of citizenship or legal status (e.g. `citizenship`, `residency`).
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country} two-letter ISO 3166-1 alpha-2 code.
+    class Citizenship
+      attr_accessor :type,
+                    :country
+    end
+  end
+end

data/lib/checkout_sdk/accounts/company.rb

@@ -10,6 +10,10 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute trading_name
     #   @return [String]
+    # @!attribute additional_trading_names
+    #   @return [Array(String)]
+    # @!attribute is_registered_company
+    #   @return [Boolean]
     # @!attribute date_of_incorporation
     #   @return [DateOfIncorporation]
     # @!attribute regulatory_licence_number
@@ -29,6 +33,8 @@ module CheckoutSdk
                     :business_type,
                     :legal_name,
                     :trading_name,
+                    :additional_trading_names,
+                    :is_registered_company,
                     :date_of_incorporation,
                     :regulatory_licence_number,
                     :principal_address,

data/lib/checkout_sdk/accounts/company_position.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module CompanyPosition
+      CEO = 'ceo'
+      CFO = 'cfo'
+      COO = 'coo'
+      MANAGING_MEMBER = 'managing_member'
+      GENERAL_PARTNER = 'general_partner'
+      PRESIDENT = 'president'
+      VICE_PRESIDENT = 'vice_president'
+      TREASURER = 'treasurer'
+      OTHER_SENIOR_MANAGEMENT = 'other_senior_management'
+      OTHER_EXECUTIVE_OFFICER = 'other_executive_officer'
+      OTHER_NON_EXECUTIVE_NON_SENIOR = 'other_non_executive_non_senior'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/date_of_incorporation.rb

@@ -2,13 +2,16 @@
 
 module CheckoutSdk
   module Accounts
+    # @!attribute day
+    #   @return [Integer]
     # @!attribute month
     #   @return [Integer]
     # @!attribute year
     #   @return [Integer]
     class DateOfIncorporation
-      attr_reader :month,
-                  :year
+      attr_accessor :day,
+                    :month,
+                    :year
     end
   end
 end

data/lib/checkout_sdk/accounts/entity_roles.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module EntityRoles
+      UBO = 'ubo'
+      LEGAL_REPRESENTATIVE = 'legal_representative'
+      AUTHORISED_SIGNATORY = 'authorised_signatory'
+      DIRECTOR = 'director'
+      CONTROL_PERSON = 'control_person'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/financial_statements.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [FinancialStatementsType]
+    # @!attribute front
+    #   @return [String]
+    class FinancialStatements
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/financial_statements_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module FinancialStatementsType
+      FINANCIAL_STATEMENTS = 'financial_statements'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/national_id_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module NationalIdType
+      SSN = 'ssn'
+      ITIN = 'itin'
+      PASSPORT = 'passport'
+      DRIVING_LICENSE = 'driving_license'
+      NATIONAL_ID_CARD = 'national_id_card'
+      RESIDENCE_PERMIT = 'residence_permit'
+      OTHER = 'other'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/onboard_entity.rb

@@ -23,6 +23,9 @@ module CheckoutSdk
     # @!attribute seller_category
     #   @return [String] Identifier of a seller category configured on the platform
     #     during onboarding. Used for US ISV onboarding variants.
+    # @!attribute agreed_terms
+    #   @return [AgreedTerms] Details of the person who agreed to the terms and
+    #     conditions (Accounts API v3.0 SaaS onboarding).
     # @!attribute submitter
     #   @return [Submitter] Captures evidence of the end-user's consent to onboarding.
     #     Used for US ISV onboarding variants.
@@ -37,6 +40,7 @@ module CheckoutSdk
                     :documents,
                     :additional_info,
                     :seller_category,
+                    :agreed_terms,
                     :submitter
     end
   end

data/lib/checkout_sdk/accounts/onboard_sub_entity_documents.rb

@@ -7,7 +7,7 @@ module CheckoutSdk
     # @!attribute company_verification
     #   @return [CompanyVerification]
     # @!attribute articles_of_association
-    #   @return [ArticlesOfAssociationType]
+    #   @return [ArticlesOfAssociation]
     # @!attribute bank_verification
     #   @return [BankVerification]
     # @!attribute shareholder_structure
@@ -26,6 +26,8 @@ module CheckoutSdk
     #   @return [TaxVerification]
     # @!attribute financial_verification
     #   @return [FinancialVerification]
+    # @!attribute financial_statements
+    #   @return [FinancialStatements]
     class OnboardSubEntityDocuments
       attr_accessor :identity_verification,
                     :company_verification,
@@ -38,7 +40,8 @@ module CheckoutSdk
                     :additional_document2,
                     :additional_document3,
                     :tax_verification,
-                    :financial_verification
+                    :financial_verification,
+                    :financial_statements
     end
   end
 end

data/lib/checkout_sdk/accounts/phone.rb

@@ -2,10 +2,13 @@
 
 module CheckoutSdk
   module Accounts
+    # @!attribute country_code
+    #   @return [String] ISO 3166-1 alpha-2 country code (Accounts API v3.0), e.g. "GB".
     # @!attribute number
     #   @return [String]
     class Phone
-      attr_accessor :number
+      attr_accessor :country_code,
+                    :number
     end
   end
 end

data/lib/checkout_sdk/accounts/processing_details.rb

@@ -10,17 +10,23 @@ module CheckoutSdk
     #   @return [Integer]
     # @!attribute average_transaction_value
     #   @return [Integer]
+    # @!attribute average_order_fulfillment_time
+    #   @return [Integer]
     # @!attribute highest_transaction_value
     #   @return [Integer]
     # @!attribute currency
     #   @return [CheckoutSdk::Common::Currency]
+    # @!attribute payments
+    #   @return [ProcessingDetailsPayments]
     class ProcessingDetails
       attr_accessor :settlement_country,
                     :target_countries,
                     :annual_processing_volume,
                     :average_transaction_value,
+                    :average_order_fulfillment_time,
                     :highest_transaction_value,
-                    :currency
+                    :currency,
+                    :payments
     end
   end
 end

data/lib/checkout_sdk/accounts/processing_details_ach.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # ACH-specific processing details (Accounts API v3.0). All values in minor units without decimals.
+    # @!attribute annual_ach_volume
+    #   @return [Integer]
+    # @!attribute average_ach_transaction_size
+    #   @return [Integer]
+    # @!attribute estimated_monthly_credit_volume
+    #   @return [Integer]
+    # @!attribute average_credit_amount
+    #   @return [Integer]
+    class ProcessingDetailsAch
+      attr_accessor :annual_ach_volume,
+                    :average_ach_transaction_size,
+                    :estimated_monthly_credit_volume,
+                    :average_credit_amount
+    end
+  end
+end

data/lib/checkout_sdk/accounts/processing_details_payments.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Payment method-specific processing details (Accounts API v3.0).
+    # @!attribute ach
+    #   @return [ProcessingDetailsAch]
+    class ProcessingDetailsPayments
+      attr_accessor :ach
+    end
+  end
+end

data/lib/checkout_sdk/accounts/representative.rb

@@ -4,6 +4,12 @@ module CheckoutSdk
   module Accounts
     # @!attribute id
     #   @return [String]
+    # @!attribute individual
+    #   @return [RepresentativeIndividual] Personal details (Accounts API v3.0).
+    # @!attribute company_position
+    #   @return [String] {CompanyPosition}
+    # @!attribute ownership_percentage
+    #   @return [Integer]
     # @!attribute first_name
     #   @return [String]
     # @!attribute last_name
@@ -24,15 +30,19 @@ module CheckoutSdk
     #   @return [OnboardSubEntityDocuments]
     class Representative
       attr_accessor :id,
+                    :individual,
+                    :company_position,
+                    :ownership_percentage,
+                    :roles,
+                    :documents,
+                    # v2.0 only — deprecated; use `individual` for v3.0
                     :first_name,
                     :last_name,
                     :address,
                     :identification,
                     :phone,
                     :date_of_birth,
-                    :place_of_birth,
-                    :roles,
-                    :documents
+                    :place_of_birth
     end
   end
 end

data/lib/checkout_sdk/accounts/representative_individual.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The personal details of a company representative ("person of interest"), as required by the
+    # Accounts API v3.0 schema.
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute middle_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [DateOfBirth]
+    # @!attribute place_of_birth
+    #   @return [PlaceOfBirth]
+    # @!attribute citizenships
+    #   @return [Array(Citizenship)]
+    # @!attribute national_id_type
+    #   @return [String] {NationalIdType}
+    # @!attribute national_id_number
+    #   @return [String]
+    # @!attribute email_address
+    #   @return [String]
+    # @!attribute phone
+    #   @return [Phone]
+    # @!attribute address
+    #   @return [CheckoutSdk::Common::Address]
+    class RepresentativeIndividual
+      attr_accessor :first_name,
+                    :middle_name,
+                    :last_name,
+                    :date_of_birth,
+                    :place_of_birth,
+                    :citizenships,
+                    :national_id_type,
+                    :national_id_number,
+                    :email_address,
+                    :phone,
+                    :address
+    end
+  end
+end

data/lib/checkout_sdk/api_client.rb

@@ -14,12 +14,12 @@ module CheckoutSdk
       @log = configuration.logger
     end
 
-    def invoke_get(path, authorization, params = nil)
-      invoke(:get, path, authorization, params: params)
+    def invoke_get(path, authorization, params = nil, headers = nil)
+      invoke(:get, path, authorization, params: params, extra_headers: headers)
     end
 
-    def invoke_post(path, authorization, request = nil, idempotency_key = nil)
-      invoke(:post, path, authorization, request, idempotency_key, params: nil)
+    def invoke_post(path, authorization, request = nil, idempotency_key = nil, headers = nil)
+      invoke(:post, path, authorization, request, idempotency_key, params: nil, extra_headers: headers)
     end
 
     def invoke_put(path, authorization, request, headers = nil)
@@ -71,9 +71,13 @@ module CheckoutSdk
     # canonical HTTP header.
     def apply_extra_headers(http_headers, extra_headers)
       return if extra_headers.nil?
-      return unless extra_headers.respond_to?(:if_match) && extra_headers.if_match
 
-      http_headers[:'If-Match'] = extra_headers.if_match
+      if extra_headers.respond_to?(:if_match) && extra_headers.if_match
+        http_headers[:'If-Match'] = extra_headers.if_match
+      end
+      return unless extra_headers.respond_to?(:accept) && extra_headers.accept
+
+      http_headers[:Accept] = extra_headers.accept
     end
 
     def append_params(path, input_params)

data/lib/checkout_sdk/checkout_api.rb

@@ -67,6 +67,8 @@ module CheckoutSdk
   #   @return [CheckoutSdk::Identities::AmlScreening::AmlScreeningClient]
   # @!attribute id_document_verification
   #   @return [CheckoutSdk::Identities::IdDocumentVerification::IdDocumentVerificationClient]
+  # @!attribute address_document_verification
+  #   @return [CheckoutSdk::Identities::AddressDocumentVerification::AddressDocumentVerificationClient]
   # @!attribute identity_verification
   #   @return [CheckoutSdk::Identities::IdentityVerification::IdentityVerificationClient]
   # @!attribute face_authentication
@@ -109,6 +111,7 @@ module CheckoutSdk
                 :applicants,
                 :aml_screening,
                 :id_document_verification,
+                :address_document_verification,
                 :identity_verification,
                 :face_authentication,
                 :apple_pay,
@@ -152,6 +155,9 @@ module CheckoutSdk
       @aml_screening = CheckoutSdk::Identities::AmlScreening::AmlScreeningClient.new(api_client, configuration)
       @id_document_verification =
         CheckoutSdk::Identities::IdDocumentVerification::IdDocumentVerificationClient.new(api_client, configuration)
+      @address_document_verification =
+        CheckoutSdk::Identities::AddressDocumentVerification::AddressDocumentVerificationClient.new(api_client,
+                                                                                                    configuration)
       @identity_verification =
         CheckoutSdk::Identities::IdentityVerification::IdentityVerificationClient.new(api_client, configuration)
       @face_authentication =

data/lib/checkout_sdk/common/headers.rb

@@ -9,8 +9,11 @@ module CheckoutSdk
     #
     # @!attribute if_match
     #   @return [String] ETag value to forward as the `If-Match` HTTP header.
+    # @!attribute accept
+    #   @return [String] value to forward as the `Accept` HTTP header, e.g.
+    #     `application/json;schema_version=3.0` for Accounts API schema negotiation.
     class Headers
-      attr_accessor :if_match
+      attr_accessor :if_match, :accept
     end
   end
 end

data/lib/checkout_sdk/forward/create_secret_request.rb

@@ -2,7 +2,7 @@
 
 module CheckoutSdk
   module Forward
-    # Request body for POST /forward/secrets.
+    # Request body for POST /secrets.
     #
     # @!attribute name
     #   @return [String] Secret name (1-64 alphanumeric chars).

data/lib/checkout_sdk/forward/forward_client.rb

@@ -25,26 +25,26 @@ module CheckoutSdk
 
       # @param [Hash, CreateSecretRequest] create_secret_request
       def create_secret(create_secret_request)
-        api_client.invoke_post(build_path(FORWARD, SECRETS),
+        api_client.invoke_post(build_path(SECRETS),
                                sdk_authorization,
                                create_secret_request)
       end
 
       def get_secrets
-        api_client.invoke_get(build_path(FORWARD, SECRETS), sdk_authorization)
+        api_client.invoke_get(build_path(SECRETS), sdk_authorization)
       end
 
       # @param [String] name
       # @param [Hash, UpdateSecretRequest] update_secret_request
       def update_secret(name, update_secret_request)
-        api_client.invoke_patch(build_path(FORWARD, SECRETS, name),
+        api_client.invoke_patch(build_path(SECRETS, name),
                                 sdk_authorization,
                                 update_secret_request)
       end
 
       # @param [String] name
       def delete_secret(name)
-        api_client.invoke_delete(build_path(FORWARD, SECRETS, name),
+        api_client.invoke_delete(build_path(SECRETS, name),
                                  sdk_authorization)
       end
     end

data/lib/checkout_sdk/forward/update_secret_request.rb

@@ -2,7 +2,7 @@
 
 module CheckoutSdk
   module Forward
-    # Request body for PATCH /forward/secrets/{name}.
+    # Request body for PATCH /secrets/{name}.
     #
     # @!attribute value
     #   @return [String] New plaintext secret value (max 8KB).

data/lib/checkout_sdk/identities/address_document_verification/address_document_verification_attempt_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module AddressDocumentVerification
+      # Request body for POST /address-document-verifications/{id}/attempts.
+      #
+      # @!attribute document
+      #   @return [String] The address document image to upload. [Required] Format: binary
+      class AddressDocumentVerificationAttemptRequest
+        attr_accessor :document
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module AddressDocumentVerification
+      # Client for the Identities — Address Document Verification (Adv) API.
+      class AddressDocumentVerificationClient < Client
+        ADDRESS_DOCUMENT_VERIFICATIONS = 'address-document-verifications'
+        ANONYMIZE = 'anonymize'
+        ATTEMPTS = 'attempts'
+        PDF_REPORT = 'pdf-report'
+        private_constant :ADDRESS_DOCUMENT_VERIFICATIONS, :ANONYMIZE, :ATTEMPTS, :PDF_REPORT
+
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+        end
+
+        # @param [Hash, AddressDocumentVerificationRequest] request
+        def create_address_document_verification(request)
+          api_client.invoke_post(ADDRESS_DOCUMENT_VERIFICATIONS, sdk_authorization, request)
+        end
+
+        # @param [String] address_document_verification_id
+        def get_address_document_verification(address_document_verification_id)
+          api_client.invoke_get(
+            build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] address_document_verification_id
+        def anonymize_address_document_verification(address_document_verification_id)
+          api_client.invoke_post(
+            build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ANONYMIZE),
+            sdk_authorization
+          )
+        end
+
+        # Create a new attempt for an existing address document verification.
+        # @param [String] address_document_verification_id
+        # @param [Hash, AddressDocumentVerificationAttemptRequest] attempt_request
+        def create_address_document_verification_attempt(address_document_verification_id, attempt_request = nil)
+          api_client.invoke_post(
+            build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ATTEMPTS),
+            sdk_authorization,
+            attempt_request
+          )
+        end
+
+        # @param [String] address_document_verification_id
+        def get_address_document_verification_attempts(address_document_verification_id)
+          api_client.invoke_get(
+            build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ATTEMPTS),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] address_document_verification_id
+        # @param [String] attempt_id
+        def get_address_document_verification_attempt(address_document_verification_id, attempt_id)
+          api_client.invoke_get(
+            build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, ATTEMPTS, attempt_id),
+            sdk_authorization
+          )
+        end
+
+        # @param [String] address_document_verification_id
+        def get_address_document_verification_pdf_report(address_document_verification_id)
+          api_client.invoke_get(
+            build_path(ADDRESS_DOCUMENT_VERIFICATIONS, address_document_verification_id, PDF_REPORT),
+            sdk_authorization
+          )
+        end
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/address_document_verification/address_document_verification_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Identities
+    module AddressDocumentVerification
+      # Request body for POST /address-document-verifications.
+      #
+      # @!attribute applicant_id
+      #   @return [String] The applicant's unique identifier. [Required] Pattern: ^aplt_\w+$
+      # @!attribute user_journey_id
+      #   @return [String] Your configuration ID. [Required] Pattern: ^usj_[a-z2-7]{26}$
+      # @!attribute declared_data
+      #   @return [IdvDeclaredData, Hash] The personal details provided by the applicant. [Optional]
+      class AddressDocumentVerificationRequest
+        attr_accessor :applicant_id,
+                      :user_journey_id,
+                      :declared_data
+      end
+    end
+  end
+end

data/lib/checkout_sdk/identities/identities.rb

@@ -14,6 +14,11 @@ require 'checkout_sdk/identities/aml_screening/aml_screening_client'
 require 'checkout_sdk/identities/id_document_verification/id_document_verification_request'
 require 'checkout_sdk/identities/id_document_verification/id_document_verification_client'
 
+# Address Document Verification
+require 'checkout_sdk/identities/address_document_verification/address_document_verification_request'
+require 'checkout_sdk/identities/address_document_verification/address_document_verification_attempt_request'
+require 'checkout_sdk/identities/address_document_verification/address_document_verification_client'
+
 # Identity Verification
 require 'checkout_sdk/identities/identity_verification/idv_declared_data'
 require 'checkout_sdk/identities/identity_verification/idv_client_information'

data/lib/checkout_sdk/oauth_scopes.rb

@@ -3,6 +3,7 @@
 module CheckoutSdk
   module OAuthScopes
     VAULT = 'vault'
+    VAULT_APME_ENROLLMENT = 'vault:apme-enrollment'
     VAULT_INSTRUMENTS = 'vault:instruments'
     VAULT_TOKENIZATION = 'vault:tokenization'
     GATEWAY = 'gateway'

data/lib/checkout_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CheckoutSdk
-  VERSION = '1.9.0'
+  VERSION = '1.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Checkout
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-02 00:00:00.000000000 Z
+date: 2026-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -149,11 +149,15 @@ files:
 - lib/checkout_sdk/accounts/accounts_client.rb
 - lib/checkout_sdk/accounts/additional_document.rb
 - lib/checkout_sdk/accounts/additional_info.rb
+- lib/checkout_sdk/accounts/agreed_terms.rb
+- lib/checkout_sdk/accounts/articles_of_association.rb
 - lib/checkout_sdk/accounts/articles_of_association_type.rb
 - lib/checkout_sdk/accounts/bank_verification.rb
 - lib/checkout_sdk/accounts/bank_verification_type.rb
 - lib/checkout_sdk/accounts/business_type.rb
+- lib/checkout_sdk/accounts/citizenship.rb
 - lib/checkout_sdk/accounts/company.rb
+- lib/checkout_sdk/accounts/company_position.rb
 - lib/checkout_sdk/accounts/company_verification.rb
 - lib/checkout_sdk/accounts/company_verification_type.rb
 - lib/checkout_sdk/accounts/contact_details.rb
@@ -170,7 +174,10 @@ files:
 - lib/checkout_sdk/accounts/entity_requirement_reason.rb
 - lib/checkout_sdk/accounts/entity_requirement_update_request.rb
 - lib/checkout_sdk/accounts/entity_requirement_update_status.rb
+- lib/checkout_sdk/accounts/entity_roles.rb
 - lib/checkout_sdk/accounts/file_request.rb
+- lib/checkout_sdk/accounts/financial_statements.rb
+- lib/checkout_sdk/accounts/financial_statements_type.rb
 - lib/checkout_sdk/accounts/financial_verification.rb
 - lib/checkout_sdk/accounts/financial_verification_type.rb
 - lib/checkout_sdk/accounts/identification.rb
@@ -182,6 +189,7 @@ files:
 - lib/checkout_sdk/accounts/instrument_details_sepa.rb
 - lib/checkout_sdk/accounts/instrument_document.rb
 - lib/checkout_sdk/accounts/invitee.rb
+- lib/checkout_sdk/accounts/national_id_type.rb
 - lib/checkout_sdk/accounts/onboard_entity.rb
 - lib/checkout_sdk/accounts/onboard_sub_entity_documents.rb
 - lib/checkout_sdk/accounts/payment_instrument.rb
@@ -190,12 +198,15 @@ files:
 - lib/checkout_sdk/accounts/phone.rb
 - lib/checkout_sdk/accounts/place_of_birth.rb
 - lib/checkout_sdk/accounts/processing_details.rb
+- lib/checkout_sdk/accounts/processing_details_ach.rb
+- lib/checkout_sdk/accounts/processing_details_payments.rb
 - lib/checkout_sdk/accounts/profile.rb
 - lib/checkout_sdk/accounts/proof_of_legality.rb
 - lib/checkout_sdk/accounts/proof_of_legality_type.rb
 - lib/checkout_sdk/accounts/proof_of_principal_address.rb
 - lib/checkout_sdk/accounts/proof_of_principal_address_type.rb
 - lib/checkout_sdk/accounts/representative.rb
+- lib/checkout_sdk/accounts/representative_individual.rb
 - lib/checkout_sdk/accounts/reserve_rule_create_request.rb
 - lib/checkout_sdk/accounts/reserve_rule_holding_duration.rb
 - lib/checkout_sdk/accounts/reserve_rule_update_request.rb
@@ -305,6 +316,9 @@ files:
 - lib/checkout_sdk/forward/forward_client.rb
 - lib/checkout_sdk/forward/update_secret_request.rb
 - lib/checkout_sdk/http_metadata.rb
+- lib/checkout_sdk/identities/address_document_verification/address_document_verification_attempt_request.rb
+- lib/checkout_sdk/identities/address_document_verification/address_document_verification_client.rb
+- lib/checkout_sdk/identities/address_document_verification/address_document_verification_request.rb
 - lib/checkout_sdk/identities/aml_screening/aml_screening_client.rb
 - lib/checkout_sdk/identities/aml_screening/aml_search_parameters.rb
 - lib/checkout_sdk/identities/aml_screening/aml_verification_request.rb