lithic 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.7

data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb

@@ -25,8 +25,7 @@ module Lithic
       #   attr_writer :account_token
 
       # @!attribute [r] beneficial_owner_entities
-      #   Only present when user_type == "BUSINESS". List of all entities with >25%
-      #     ownership in the company.
+      #   Deprecated.
       #
       #   @return [Array<Lithic::Models::KYBBusinessEntity>, nil]
       optional :beneficial_owner_entities,
@@ -37,8 +36,11 @@ module Lithic
       #   attr_writer :beneficial_owner_entities
 
       # @!attribute [r] beneficial_owner_individuals
-      #   Only present when user_type == "BUSINESS". List of all individuals with >25%
-      #     ownership in the company.
+      #   Only present when user_type == "BUSINESS". List of all direct and indirect
+      #   individuals with 25% or more ownership in the company. If no individual owns 25%
+      #   of the company, please identify the largest shareholder in this field. 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.
       #
       #   @return [Array<Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual>, nil]
       optional :beneficial_owner_individuals,
@@ -50,8 +52,8 @@ module Lithic
 
       # @!attribute [r] business_account_token
       #   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.
+      #   users of businesses. Pass the account_token of the enrolled business associated
+      #   with the AUTHORIZED_USER in this field.
       #
       #   @return [String, nil]
       optional :business_account_token, String
@@ -62,7 +64,7 @@ module Lithic
 
       # @!attribute [r] business_entity
       #   Only present when user_type == "BUSINESS". Information about the business for
-      #     which the account is being opened and KYB is being run.
+      #   which the account is being opened and KYB is being run.
       #
       #   @return [Lithic::Models::KYBBusinessEntity, nil]
       optional :business_entity, -> { Lithic::Models::KYBBusinessEntity }
@@ -74,15 +76,15 @@ module Lithic
       # @!attribute [r] control_person
       #   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,
+      #   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
+      #   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.
+      #   to the cards that Lithic will provide. In some cases, this individual could also
+      #   be a beneficial owner listed above.
       #
       #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson, nil]
       optional :control_person,
@@ -104,9 +106,9 @@ module Lithic
 
       # @!attribute [r] email
       #   < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
-      #     individual.phone_number when user_type == "INDIVIDUAL".
+      #   individual.phone_number when user_type == "INDIVIDUAL".
       #
-      #     > Primary email of Account Holder.
+      #   > Primary email of Account Holder.
       #
       #   @return [String, nil]
       optional :email, String
@@ -117,7 +119,7 @@ module Lithic
 
       # @!attribute [r] exemption_type
       #   The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
-      #     holder is not KYC-Exempt.
+      #   holder is not KYC-Exempt.
       #
       #   @return [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType, nil]
       optional :exemption_type,
@@ -129,7 +131,7 @@ module Lithic
 
       # @!attribute [r] external_id
       #   Customer-provided token that indicates a relationship with an object outside of
-      #     the Lithic ecosystem.
+      #   the Lithic ecosystem.
       #
       #   @return [String, nil]
       optional :external_id, String
@@ -140,7 +142,7 @@ module Lithic
 
       # @!attribute [r] individual
       #   Only present when user_type == "INDIVIDUAL". Information about the individual
-      #     for which the account is being opened and KYC is being run.
+      #   for which the account is being opened and KYC is being run.
       #
       #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual, nil]
       optional :individual, -> { Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual }
@@ -151,7 +153,7 @@ module Lithic
 
       # @!attribute [r] nature_of_business
       #   Only present when user_type == "BUSINESS". User-submitted description of the
-      #     business.
+      #   business.
       #
       #   @return [String, nil]
       optional :nature_of_business, String
@@ -162,9 +164,9 @@ module Lithic
 
       # @!attribute [r] phone_number
       #   < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
-      #     individual.phone_number when user_type == "INDIVIDUAL".
+      #   individual.phone_number when user_type == "INDIVIDUAL".
       #
-      #     > Primary phone of Account Holder, entered in E.164 format.
+      #   > Primary phone of Account Holder, entered in E.164 format.
       #
       #   @return [String, nil]
       optional :phone_number, String
@@ -175,7 +177,7 @@ module Lithic
 
       # @!attribute [r] required_documents
       #   Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
-      #     required for the account holder to be approved.
+      #   required for the account holder to be approved.
       #
       #   @return [Array<Lithic::Models::RequiredDocument>, nil]
       optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::RequiredDocument] }
@@ -187,10 +189,10 @@ module Lithic
       # @!attribute [r] status
       #   <Deprecated. Use verification_application.status instead>
       #
-      #     KYC and KYB evaluation states.
+      #   KYC and KYB evaluation states.
       #
-      #     Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-      #     `ADVANCED` workflow.
+      #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+      #   `ADVANCED` workflow.
       #
       #   @return [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status, nil]
       optional :status, enum: -> { Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status }
@@ -201,7 +203,7 @@ module Lithic
 
       # @!attribute [r] status_reasons
       #   <Deprecated. Use verification_application.status_reasons> Reason for the
-      #     evaluation status.
+      #   evaluation status.
       #
       #   @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason>, nil]
       optional :status_reasons,
@@ -213,12 +215,11 @@ module Lithic
 
       # @!attribute [r] user_type
       #   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", "beneficial_owner_entities",
+      #   attribute will be present.
       #
-      #     "nature_of_business", and "website_url" attributes 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.
       #
       #   @return [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::UserType, nil]
       optional :user_type, enum: -> { Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::UserType }
@@ -301,7 +302,7 @@ module Lithic
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute [r] 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 currently supported.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address, nil]
         optional :address,
@@ -323,7 +324,7 @@ module Lithic
 
         # @!attribute [r] email
         #   Individual's email address. If utilizing Lithic for chargeback processing, this
-        #     customer email address may be used to communicate dispute status and resolution.
+        #   customer email address may be used to communicate dispute status and resolution.
         #
         #   @return [String, nil]
         optional :email, String
@@ -390,21 +391,21 @@ module Lithic
 
           # @!attribute country
           #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #     3166-1 alpha-3 three-character format.
+          #   3166-1 alpha-3 three-character format.
           #
           #   @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.
+          #   five-digit ZIP or nine-digit ZIP+4.
           #
           #   @return [String]
           required :postal_code, String
 
           # @!attribute state
           #   Valid state code. Only USA state codes are currently supported, entered in
-          #     uppercase ISO 3166-2 two-character format.
+          #   uppercase ISO 3166-2 two-character format.
           #
           #   @return [String]
           required :state, String
@@ -421,7 +422,7 @@ module Lithic
 
           # @!parse
           #   # 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 currently supported.
           #   #
           #   # @param address1 [String]
           #   # @param city [String]
@@ -440,7 +441,7 @@ module Lithic
       class ControlPerson < Lithic::Internal::Type::BaseModel
         # @!attribute [r] 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 currently supported.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address, nil]
         optional :address,
@@ -462,7 +463,7 @@ module Lithic
 
         # @!attribute [r] email
         #   Individual's email address. If utilizing Lithic for chargeback processing, this
-        #     customer email address may be used to communicate dispute status and resolution.
+        #   customer email address may be used to communicate dispute status and resolution.
         #
         #   @return [String, nil]
         optional :email, String
@@ -504,15 +505,15 @@ module Lithic
         # @!parse
         #   # 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,
+        #   # 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
+        #   # 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.
+        #   # to the cards that Lithic will provide. In some cases, this individual could also
+        #   # be a beneficial owner listed above.
         #   #
         #   # @param address [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address]
         #   # @param dob [String]
@@ -541,21 +542,21 @@ module Lithic
 
           # @!attribute country
           #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #     3166-1 alpha-3 three-character format.
+          #   3166-1 alpha-3 three-character format.
           #
           #   @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.
+          #   five-digit ZIP or nine-digit ZIP+4.
           #
           #   @return [String]
           required :postal_code, String
 
           # @!attribute state
           #   Valid state code. Only USA state codes are currently supported, entered in
-          #     uppercase ISO 3166-2 two-character format.
+          #   uppercase ISO 3166-2 two-character format.
           #
           #   @return [String]
           required :state, String
@@ -572,7 +573,7 @@ module Lithic
 
           # @!parse
           #   # 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 currently supported.
           #   #
           #   # @param address1 [String]
           #   # @param city [String]
@@ -588,7 +589,7 @@ module Lithic
       end
 
       # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
-      #   holder is not KYC-Exempt.
+      # holder is not KYC-Exempt.
       #
       # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#exemption_type
       module ExemptionType
@@ -608,7 +609,7 @@ module Lithic
       class Individual < Lithic::Internal::Type::BaseModel
         # @!attribute [r] 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 currently supported.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address, nil]
         optional :address,
@@ -630,7 +631,7 @@ module Lithic
 
         # @!attribute [r] email
         #   Individual's email address. If utilizing Lithic for chargeback processing, this
-        #     customer email address may be used to communicate dispute status and resolution.
+        #   customer email address may be used to communicate dispute status and resolution.
         #
         #   @return [String, nil]
         optional :email, String
@@ -671,7 +672,7 @@ module Lithic
 
         # @!parse
         #   # Only present when user_type == "INDIVIDUAL". Information about the individual
-        #   #   for which the account is being opened and KYC is being run.
+        #   # for which the account is being opened and KYC is being run.
         #   #
         #   # @param address [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address]
         #   # @param dob [String]
@@ -700,21 +701,21 @@ module Lithic
 
           # @!attribute country
           #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #     3166-1 alpha-3 three-character format.
+          #   3166-1 alpha-3 three-character format.
           #
           #   @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.
+          #   five-digit ZIP or nine-digit ZIP+4.
           #
           #   @return [String]
           required :postal_code, String
 
           # @!attribute state
           #   Valid state code. Only USA state codes are currently supported, entered in
-          #     uppercase ISO 3166-2 two-character format.
+          #   uppercase ISO 3166-2 two-character format.
           #
           #   @return [String]
           required :state, String
@@ -731,7 +732,7 @@ module Lithic
 
           # @!parse
           #   # 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 currently supported.
           #   #
           #   # @param address1 [String]
           #   # @param city [String]
@@ -748,10 +749,10 @@ module Lithic
 
       # <Deprecated. Use verification_application.status instead>
       #
-      #   KYC and KYB evaluation states.
+      # KYC and KYB evaluation states.
       #
-      #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-      #   `ADVANCED` workflow.
+      # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+      # `ADVANCED` workflow.
       #
       # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#status
       module Status
@@ -808,12 +809,11 @@ module Lithic
       end
 
       # 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", "beneficial_owner_entities",
+      # attribute will be present.
       #
-      #   "nature_of_business", and "website_url" attributes 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.
       #
       # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#user_type
       module UserType
@@ -840,8 +840,8 @@ module Lithic
         # @!attribute status
         #   KYC and KYB evaluation states.
         #
-        #     Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-        #     `ADVANCED` workflow.
+        #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+        #   `ADVANCED` workflow.
         #
         #   @return [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::Status]
         required :status,
@@ -874,8 +874,8 @@ module Lithic
 
         # KYC and KYB evaluation states.
         #
-        #   Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
-        #   `ADVANCED` workflow.
+        # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
+        # `ADVANCED` workflow.
         #
         # @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication#status
         module Status