Class: Lithic::Models::AccountHolderUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/account_holder_update_params.rb

Overview

See Also:

Defined Under Namespace

Classes: BeneficialOwnerEntity, BeneficialOwnerIndividual, BusinessEntity, ControlPerson, Individual

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(entity_token:, address: nil, dob: nil, email: nil, first_name: nil, government_id: nil, last_name: nil, phone_number: nil) ⇒ Object

Some parameter documentations has been truncated, see ControlPerson for more details.

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](www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.

Parameters:

  • entity_token (String) —

    Globally unique identifier for an entity.

  • address (Lithic::Models::AddressUpdate) (defaults to: nil) —

    Individual’s current address - PO boxes, UPS drops, and FedEx drops are not acce

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

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

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

    Individual’s email address. If utilizing Lithic for chargeback processing, this

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

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

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

    Government-issued identification number (required for identity verification and

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

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

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

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




# File 'lib/lithic/models/account_holder_update_params.rb', line 209

Instance Attribute Details

#address ⇒ Lithic::Models::AddressUpdate?

Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.

Returns:



82
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 82

optional :address, -> { Lithic::AddressUpdate }

#beneficial_owner_entities ⇒ Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>?

Deprecated.

Deprecated.

Returns:



16
17
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 16

optional :beneficial_owner_entities,
-> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderUpdateParams::BeneficialOwnerEntity] }

#beneficial_owner_individuals ⇒ Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>?

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](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.

Returns:



28
29
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 28

optional :beneficial_owner_individuals,
-> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderUpdateParams::BeneficialOwnerIndividual] }

#business_account_token ⇒ String?

Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the account holder is associated.

Returns:

  • (String, nil) 


89
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 89

optional :business_account_token, String

#business_entity ⇒ Lithic::Models::AccountHolderUpdateParams::BusinessEntity?

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

Returns:



36
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 36

optional :business_entity, -> { Lithic::AccountHolderUpdateParams::BusinessEntity }

#control_person ⇒ Lithic::Models::AccountHolderUpdateParams::ControlPerson?

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](www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.

Returns:



49
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 49

optional :control_person, -> { Lithic::AccountHolderUpdateParams::ControlPerson }

#email ⇒ String?

Allowed for all Account Holders. Account holder’s email address. The primary purpose of this field is for cardholder identification and verification during the digital wallet tokenization process.

Returns:

  • (String, nil) 


97
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 97

optional :email, String

#external_id ⇒ String?

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

Returns:

  • (String, nil) 


56
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 56

optional :external_id, String

#first_name ⇒ String?

Allowed for KYC-Exempt, BYO-KYC. Account holder’s first name.

Returns:

  • (String, nil) 


103
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 103

optional :first_name, String

#individual ⇒ Lithic::Models::AccountHolderUpdateParams::Individual?

Information on the individual for whom the account is being opened and KYC is being run.

Returns:



76
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 76

optional :individual, -> { Lithic::AccountHolderUpdateParams::Individual }

#last_name ⇒ String?

Allowed for KYC-Exempt, BYO-KYC. Account holder’s last name.

Returns:

  • (String, nil) 


109
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 109

optional :last_name, String

#legal_business_name ⇒ String?

Allowed for BYO-KYB. Legal business name of the account holder.

Returns:

  • (String, nil) 


115
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 115

optional :legal_business_name, String

#nature_of_business ⇒ String?

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

Returns:

  • (String, nil) 


63
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 63

optional :nature_of_business, String

#phone_number ⇒ String?

Allowed for all Account Holders. Account holder’s phone number, entered in E.164 format. The primary purpose of this field is for cardholder identification and verification during the digital wallet tokenization process.

Returns:

  • (String, nil) 


123
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 123

optional :phone_number, String

#website_url ⇒ String?

Company website URL.

Returns:

  • (String, nil) 


69
 
# File 'lib/lithic/models/account_holder_update_params.rb', line 69

optional :website_url, String