Class: Lithic::Models::KYBBusinessEntity

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

Defined Under Namespace

Classes: Address

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(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil) ⇒ Object

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

Parameters:

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

    Business”s physical address - PO boxes, UPS drops, and FedEx drops are not acce

  • government_id (String) —

    Government-issued identification number. US Federal Employer Identification Numb

  • legal_business_name (String) —

    Legal (formal) business name.

  • phone_numbers (Array<String>) —

    One or more of the business’s phone number(s), entered as a list in E.164 format

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

    Any name that the business operates under that is not its legal business name (i

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

    Parent company name (if applicable).




# File 'lib/lithic/models/kyb_business_entity.rb', line 47

Instance Attribute Details

#address ⇒ Lithic::Models::KYBBusinessEntity::Address

Business”s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

Returns:



11
 
# File 'lib/lithic/models/kyb_business_entity.rb', line 11

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

#dba_business_name ⇒ String?

Any name that the business operates under that is not its legal business name (if applicable).

Returns:

  • (String, nil) 


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

optional :dba_business_name, String

#government_id ⇒ String

Government-issued identification number. US Federal Employer Identification Numbers (EIN) are currently supported, entered as full nine-digits, with or without hyphens.

Returns:

  • (String) 


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

required :government_id, String

#legal_business_name ⇒ String

Legal (formal) business name.

Returns:

  • (String) 


25
 
# File 'lib/lithic/models/kyb_business_entity.rb', line 25

required :legal_business_name, String

#parent_company ⇒ String?

Parent company name (if applicable).

Returns:

  • (String, nil) 


45
 
# File 'lib/lithic/models/kyb_business_entity.rb', line 45

optional :parent_company, String

#phone_numbers ⇒ Array<String>

One or more of the business’s phone number(s), entered as a list in E.164 format.

Returns:

  • (Array<String>) 


32
 
# File 'lib/lithic/models/kyb_business_entity.rb', line 32

required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]