lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/rbi/lib/lithic/models/account_holder_create_params.rbi

@@ -185,24 +185,70 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # You must submit a list of all direct and indirect individuals with 25% or more
+        # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+        # no individual owns 25% of the company you do not need to send beneficial owner
+        # information. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section I) for more background on individuals that should be included.
         beneficial_owner_individuals:,
+        # Information for business for which the account is being opened and KYB is being
+        # run.
         business_entity:,
+        # An individual with significant responsibility for managing the legal entity
+        # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+        # Officer, Managing Member, General Partner, President, Vice President, or
+        # Treasurer). This can be an executive, or someone who will have program-wide
+        # access to the cards that Lithic will provide. In some cases, this individual
+        # could also be a beneficial owner listed above. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section II) for more background.
         control_person:,
+        # Short description of the company's line of business (i.e., what does the company
+        # do?).
         nature_of_business:,
+        # An RFC 3339 timestamp indicating when the account holder accepted the applicable
+        # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+        # implementation with Lithic.
         tos_timestamp:,
+        # Specifies the workflow type. This must be 'KYC_EXEMPT'
         workflow:,
+        # Information on individual for whom the account is being opened and KYC is being
+        # run.
         individual:,
+        # KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
+        # acceptable; APO/FPO are acceptable.
         address:,
+        # The KYC Exempt user's email
         email:,
+        # The KYC Exempt user's first name
         first_name:,
+        # Specifies the type of KYC Exempt user
         kyc_exemption_type:,
+        # The KYC Exempt user's last name
         last_name:,
+        # The KYC Exempt user's phone number, entered in E.164 format.
         phone_number:,
+        # Deprecated.
         beneficial_owner_entities: nil,
+        # A user provided id that can be used to link an account holder with an external
+        # system
         external_id: nil,
+        # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+        # business with a pass result.
+        #
+        # This field is required only if workflow type is `KYB_BYO`.
         kyb_passed_timestamp: nil,
+        # Company website URL.
         website_url: nil,
+        # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+        # individual with a pass result.
+        #
+        # This field is required only if workflow type is `KYC_BYO`.
         kyc_passed_timestamp: nil,
+        # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+        # users of businesses. Pass the account_token of the enrolled business associated
+        # with the AUTHORIZED_USER in this field.
         business_account_token: nil,
         request_options: {}
       ); end
@@ -288,8 +334,27 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -360,11 +425,22 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable.
           address:,
+          # Government-issued identification number. US Federal Employer Identification
+          # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+          # without hyphens.
           government_id:,
+          # Legal (formal) business name.
           legal_business_name:,
+          # One or more of the business's phone number(s), entered as a list in E.164
+          # format.
           phone_numbers:,
+          # Any name that the business operates under that is not its legal business name
+          # (if applicable).
           dba_business_name: nil,
+          # Parent company name (if applicable).
           parent_company: nil
         ); end
         sig do
@@ -443,8 +519,27 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -526,11 +621,22 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable.
           address:,
+          # Government-issued identification number. US Federal Employer Identification
+          # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+          # without hyphens.
           government_id:,
+          # Legal (formal) business name.
           legal_business_name:,
+          # One or more of the business's phone number(s), entered as a list in E.164
+          # format.
           phone_numbers:,
+          # Any name that the business operates under that is not its legal business name
+          # (if applicable).
           dba_business_name: nil,
+          # Parent company name (if applicable).
           parent_company: nil
         ); end
         sig do
@@ -600,8 +706,27 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:); end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number:
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/account_holder_create_response.rbi

@@ -62,16 +62,27 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the account holder.
         token:,
+        # Globally unique identifier for the account.
         account_token:,
+        # KYC and KYB evaluation states.
+        #
+        # Note:
+        #
+        # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
         status:,
+        # Reason for the evaluation status.
         status_reasons:,
+        # Timestamp of when the account holder was created.
         created: nil,
+        # Customer-provided token that indicates a relationship with an object outside of
+        # the Lithic ecosystem.
         external_id: nil,
+        # Only present for "KYB_BASIC" workflow. A list of documents required for the
+        # account holder to be approved.
         required_documents: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/account_holder_list_params.rbi

@@ -109,16 +109,35 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
         begin_: nil,
+        # Email address of the account holder. The query must be an exact match, case
+        # insensitive.
         email: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
         end_: nil,
+        # A cursor representing an item's token before which a page of results should end.
+        # Used to retrieve the previous page of results before this item.
         ending_before: nil,
+        # If applicable, represents the external_id associated with the account_holder.
         external_id: nil,
+        # (Individual Account Holders only) The first name of the account holder. The
+        # query is case insensitive and supports partial matches.
         first_name: nil,
+        # (Individual Account Holders only) The last name of the account holder. The query
+        # is case insensitive and supports partial matches.
         last_name: nil,
+        # (Business Account Holders only) The legal business name of the account holder.
+        # The query is case insensitive and supports partial matches.
         legal_business_name: nil,
+        # The number of account_holders to limit the response to.
         limit: nil,
+        # Phone number of the account holder. The query must be an exact match.
         phone_number: nil,
+        # A cursor representing an item's token after which a page of results should
+        # begin. Used to retrieve the next page of results after this item.
         starting_after: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi

@@ -49,9 +49,14 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # The account holder document upload which to perform the simulation upon.
         document_upload_token:,
+        # An account holder document's upload status for use within the simulation.
         status:,
+        # A list of status reasons associated with a KYB account holder in PENDING_REVIEW
         accepted_entity_status_reasons: nil,
+        # Status reason that will be associated with the simulated account holder status.
+        # Only required for a `REJECTED` status or `PARTIAL_APPROVAL` status.
         status_reason: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi

@@ -46,8 +46,16 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(account_holder_token: nil, status: nil, status_reasons: nil, request_options: {}); end
-
+      def self.new(
+        # The account holder which to perform the simulation upon.
+        account_holder_token: nil,
+        # An account holder's status for use within the simulation.
+        status: nil,
+        # Status reason that will be associated with the simulated account holder status.
+        # Only required for a `REJECTED` status.
+        status_reasons: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi

@@ -291,25 +291,85 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the account holder.
         token: nil,
+        # Globally unique identifier for the account.
         account_token: nil,
+        # Deprecated.
         beneficial_owner_entities: nil,
+        # Only present when user_type == "BUSINESS". You must submit a list of all direct
+        # and indirect individuals with 25% or more ownership in the company. A maximum of
+        # 4 beneficial owners can be submitted. If no individual owns 25% of the company
+        # you do not need to send beneficial owner information. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section I) for more background on individuals that should be included.
         beneficial_owner_individuals: nil,
+        # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+        # users of businesses. Pass the account_token of the enrolled business associated
+        # with the AUTHORIZED_USER in this field.
         business_account_token: nil,
+        # Only present when user_type == "BUSINESS". Information about the business for
+        # which the account is being opened and KYB is being run.
         business_entity: nil,
+        # Only present when user_type == "BUSINESS".
+        #
+        # An individual with significant responsibility for managing the legal entity
+        # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+        # Officer,
+        #
+        # Managing Member, General Partner, President, Vice President, or Treasurer). This
+        # can be an executive, or someone who will have program-wide access
+        #
+        # to the cards that Lithic will provide. In some cases, this individual could also
+        # be a beneficial owner listed above.
         control_person: nil,
+        # Timestamp of when the account holder was created.
         created: nil,
+        # < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
+        # individual.phone_number when user_type == "INDIVIDUAL".
+        #
+        # > Primary email of Account Holder.
         email: nil,
+        # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
+        # holder is not KYC-Exempt.
         exemption_type: nil,
+        # Customer-provided token that indicates a relationship with an object outside of
+        # the Lithic ecosystem.
         external_id: nil,
+        # Only present when user_type == "INDIVIDUAL". Information about the individual
+        # for which the account is being opened and KYC is being run.
         individual: nil,
+        # Only present when user_type == "BUSINESS". User-submitted description of the
+        # business.
         nature_of_business: nil,
+        # < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
+        # individual.phone_number when user_type == "INDIVIDUAL".
+        #
+        # > Primary phone of Account Holder, entered in E.164 format.
         phone_number: nil,
+        # Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
+        # required for the account holder to be approved.
         required_documents: nil,
+        # <Deprecated. Use verification_application.status instead>
+        #
+        # KYC and KYB evaluation states.
+        #
+        # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+        # `ADVANCED` workflow.
         status: nil,
+        # <Deprecated. Use verification_application.status_reasons> Reason for the
+        # evaluation status.
         status_reasons: nil,
+        # The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
+        # attribute will be present.
+        #
+        # If the type is "BUSINESS" then the "business_entity", "control_person",
+        # "beneficial_owner_individuals", "nature_of_business", and "website_url"
+        # attributes will be present.
         user_type: nil,
+        # Information about the most recent identity verification attempt
         verification_application: nil,
+        # Only present when user_type == "BUSINESS". Business's primary website.
         website_url: nil
       ); end
       sig do
@@ -414,9 +474,22 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone_number: nil)
-        end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address: nil,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob: nil,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email: nil,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name: nil,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name: nil,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -477,8 +550,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
-
+          def self.new(
+            # Valid deliverable address (no PO boxes).
+            address1:,
+            # Name of city.
+            city:,
+            # Valid country code. Only USA is currently supported, entered in uppercase ISO
+            # 3166-1 alpha-3 three-character format.
+            country:,
+            # Valid postal code. Only USA ZIP codes are currently supported, entered as a
+            # five-digit ZIP or nine-digit ZIP+4.
+            postal_code:,
+            # Valid state code. Only USA state codes are currently supported, entered in
+            # uppercase ISO 3166-2 two-character format.
+            state:,
+            # Unit or apartment number (if applicable).
+            address2: nil
+          ); end
           sig do
             override
               .returns(
@@ -574,9 +662,22 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone_number: nil)
-        end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address: nil,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob: nil,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email: nil,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name: nil,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name: nil,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -637,8 +738,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
-
+          def self.new(
+            # Valid deliverable address (no PO boxes).
+            address1:,
+            # Name of city.
+            city:,
+            # Valid country code. Only USA is currently supported, entered in uppercase ISO
+            # 3166-1 alpha-3 three-character format.
+            country:,
+            # Valid postal code. Only USA ZIP codes are currently supported, entered as a
+            # five-digit ZIP or nine-digit ZIP+4.
+            postal_code:,
+            # Valid state code. Only USA state codes are currently supported, entered in
+            # uppercase ISO 3166-2 two-character format.
+            state:,
+            # Unit or apartment number (if applicable).
+            address2: nil
+          ); end
           sig do
             override
               .returns(
@@ -754,9 +870,22 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address: nil, dob: nil, email: nil, first_name: nil, last_name: nil, phone_number: nil)
-        end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address: nil,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob: nil,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email: nil,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name: nil,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name: nil,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -817,8 +946,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
-
+          def self.new(
+            # Valid deliverable address (no PO boxes).
+            address1:,
+            # Name of city.
+            city:,
+            # Valid country code. Only USA is currently supported, entered in uppercase ISO
+            # 3166-1 alpha-3 three-character format.
+            country:,
+            # Valid postal code. Only USA ZIP codes are currently supported, entered as a
+            # five-digit ZIP or nine-digit ZIP+4.
+            postal_code:,
+            # Valid state code. Only USA state codes are currently supported, entered in
+            # uppercase ISO 3166-2 two-character format.
+            state:,
+            # Unit or apartment number (if applicable).
+            address2: nil
+          ); end
           sig do
             override
               .returns(
@@ -1076,8 +1220,19 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(created:, status:, status_reasons:, updated:); end
-
+        def self.new(
+          # Timestamp of when the application was created.
+          created:,
+          # KYC and KYB evaluation states.
+          #
+          # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+          # `ADVANCED` workflow.
+          status:,
+          # Reason for the evaluation status.
+          status_reasons:,
+          # Timestamp of when the application was last updated.
+          updated:
+        ); end
         sig do
           override
             .returns(