Class: Lithic::Models::KYB

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

Defined Under Namespace

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

Instance Attribute Summary collapse

Class Method 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(address:, dob:, email:, first_name:, government_id:, last_name:, 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:

  • 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) (defaults to: nil) —

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




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

Instance Attribute Details

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

Deprecated.

Deprecated.

Returns:



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

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

#beneficial_owner_individuals ⇒ Array<Lithic::Models::KYB::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:



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

required :beneficial_owner_individuals,
-> { Lithic::Internal::Type::ArrayOf[Lithic::KYB::BeneficialOwnerIndividual] }

#business_entity ⇒ Lithic::Models::KYB::BusinessEntity

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

Returns:



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

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

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



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

required :control_person, -> { Lithic::KYB::ControlPerson }

#external_id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :external_id, String

#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) 


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

optional :kyb_passed_timestamp, String

#nature_of_business ⇒ String

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

Returns:

  • (String) 


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

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


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

required :tos_timestamp, String

#website_url ⇒ String?

Company website URL.

Returns:

  • (String, nil) 


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

optional :website_url, String

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

Specifies the type of KYB workflow to run.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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