Class: Lithic::Models::AccountHolderCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: KYCExemptionType, Workflow Classes: BeneficialOwnerEntity, BeneficialOwnerIndividual, BusinessEntity, ControlPerson, Individual

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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

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

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

Parameters:

  • address (Lithic::Models::Address) —

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

  • dob (String) —

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

  • email (String) —

    Individual’s email address.

  • first_name (String) —

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

  • government_id (String) —

    Government-issued identification number (required for identity verification and

  • last_name (String) —

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

  • phone_number (String) —

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




# File 'lib/lithic/models/account_holder_create_params.rb', line 246

Instance Attribute Details

#address ⇒ Lithic::Models::Address

KYC Exempt user’s current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

Returns:



114
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 114

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

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

Deprecated.

Deprecated.

Returns:



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

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

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

You can 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:



19
20
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 19

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

#business_account_token ⇒ String?

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.

Returns:

  • (String, nil) 


152
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 152

optional :business_account_token, String

#business_entity ⇒ Lithic::Models::AccountHolderCreateParams::BusinessEntity

Information for business for which the account is being opened.

Returns:



26
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 26

required :business_entity, -> { Lithic::AccountHolderCreateParams::BusinessEntity }

#control_person ⇒ Lithic::Models::AccountHolderCreateParams::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:



39
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 39

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

#email ⇒ String

The KYC Exempt user’s email

Returns:

  • (String) 


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

required :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) 


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

optional :external_id, String

#first_name ⇒ String

The KYC Exempt user’s first name

Returns:

  • (String) 


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

required :first_name, String

#individual ⇒ Lithic::Models::AccountHolderCreateParams::Individual

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

Returns:



98
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 98

required :individual, -> { Lithic::AccountHolderCreateParams::Individual }

#kyb_passed_timestamp ⇒ String?

An RFC 3339 timestamp indicating when precomputed KYB was completed on the business with a pass result.

This field is required only if workflow type is ‘KYB_BYO`.

Returns:

  • (String, nil) 


85
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 85

optional :kyb_passed_timestamp, String

#kyc_exemption_type ⇒ Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType

Specifies the type of KYC Exempt user

Returns:



132
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 132

required :kyc_exemption_type, enum: -> { Lithic::AccountHolderCreateParams::KYCExemptionType }

#kyc_passed_timestamp ⇒ String?

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`.

Returns:

  • (String, nil) 


107
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 107

optional :kyc_passed_timestamp, String

#last_name ⇒ String

The KYC Exempt user’s last name

Returns:

  • (String) 


138
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 138

required :last_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) 


46
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 46

optional :nature_of_business, String

#phone_number ⇒ String

The KYC Exempt user’s phone number, entered in E.164 format.

Returns:

  • (String) 


144
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 144

required :phone_number, String

#tos_timestamp ⇒ String

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.

Returns:

  • (String) 


54
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 54

required :tos_timestamp, String

#website_url ⇒ String?

Company website URL.

Returns:

  • (String, nil) 


91
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 91

optional :website_url, String

#workflow ⇒ Symbol, Lithic::Models::AccountHolderCreateParams::Workflow

Specifies the workflow type. This must be ‘KYC_EXEMPT’

Returns:



60
 
# File 'lib/lithic/models/account_holder_create_params.rb', line 60

required :workflow, enum: -> { Lithic::AccountHolderCreateParams::Workflow }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/account_holder_create_params.rb', line 411