Class: Lithic::Models::KYB::BeneficialOwnerIndividual

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/kyb.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, website_url: nil) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::KYB for more details.

Parameters:

  • beneficial_owner_individuals (Array<Lithic::Models::KYB::BeneficialOwnerIndividual>) —

    You must submit a list of all direct and indirect individuals with 25% or more o

  • business_entity (Lithic::Models::KYB::BusinessEntity) —

    Information for business for which the account is being opened and KYB is being

  • control_person (Lithic::Models::KYB::ControlPerson) —

    An individual with significant responsibility for managing the legal entity (e.g

  • nature_of_business (String) —

    Short description of the company’s line of business (i.e., what does the company

  • tos_timestamp (String) —

    An RFC 3339 timestamp indicating when the account holder accepted the applicable

  • workflow (Symbol, Lithic::Models::KYB::Workflow) —

    Specifies the type of KYB workflow to run.

  • beneficial_owner_entities (Array<Lithic::Models::KYB::BeneficialOwnerEntity>) (defaults to: nil) —

    Deprecated.

  • external_id (String) (defaults to: nil) —

    A user provided id that can be used to link an account holder with an external s

  • kyb_passed_timestamp (String) (defaults to: nil) —

    An RFC 3339 timestamp indicating when precomputed KYB was completed on the busin

  • website_url (String) (defaults to: nil) —

    Company website URL.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/lithic/models/kyb.rb', line 114

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.
  #
  #   @return [Lithic::Models::Address]
  required :address, -> { Lithic::Address }

  # @!attribute dob
  #   Individual's date of birth, as an RFC 3339 date.
  #
  #   @return [String]
  required :dob, String

  # @!attribute email
  #   Individual's email address. If utilizing Lithic for chargeback processing, this
  #   customer email address may be used to communicate dispute status and resolution.
  #
  #   @return [String]
  required :email, String

  # @!attribute first_name
  #   Individual's first name, as it appears on government-issued identity documents.
  #
  #   @return [String]
  required :first_name, String

  # @!attribute government_id
  #   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
  #
  #   @return [String]
  required :government_id, String

  # @!attribute last_name
  #   Individual's last name, as it appears on government-issued identity documents.
  #
  #   @return [String]
  required :last_name, String

  # @!attribute phone_number
  #   Individual's phone number, entered in E.164 format.
  #
  #   @return [String, nil]
  optional :phone_number, String

  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
  #   Some parameter documentations has been truncated, see
  #   {Lithic::Models::KYB::BeneficialOwnerIndividual} for more details.
  #
  #   Individuals associated with a KYB application. Phone number is optional.
  #
  #   @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
  #
  #   @param dob [String] Individual's date of birth, as an RFC 3339 date.
  #
  #   @param email [String] Individual's email address.
  #
  #   @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
  #
  #   @param government_id [String] Government-issued identification number (required for identity verification and
  #
  #   @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
  #
  #   @param phone_number [String] Individual's phone number, entered in E.164 format.
end

Instance Attribute Details

#address ⇒ Lithic::Models::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.

Returns:



120
 
# File 'lib/lithic/models/kyb.rb', line 120

required :address, -> { Lithic::Address }

#dob ⇒ String

Individual’s date of birth, as an RFC 3339 date.

Returns:

  • (String) 


126
 
# File 'lib/lithic/models/kyb.rb', line 126

required :dob, String

#email ⇒ String

Individual’s email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

Returns:

  • (String) 


133
 
# File 'lib/lithic/models/kyb.rb', line 133

required :email, String

#first_name ⇒ String

Individual’s first name, as it appears on government-issued identity documents.

Returns:

  • (String) 


139
 
# File 'lib/lithic/models/kyb.rb', line 139

required :first_name, String

#government_id ⇒ String

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

Returns:

  • (String) 


148
 
# File 'lib/lithic/models/kyb.rb', line 148

required :government_id, String

#last_name ⇒ String

Individual’s last name, as it appears on government-issued identity documents.

Returns:

  • (String) 


154
 
# File 'lib/lithic/models/kyb.rb', line 154

required :last_name, String

#phone_number ⇒ String?

Individual’s phone number, entered in E.164 format.

Returns:

  • (String, nil) 


160
 
# File 'lib/lithic/models/kyb.rb', line 160

optional :phone_number, String