Class: ModernTreasury::Models::LegalEntity

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::LegalEntity

Defined in:

lib/modern_treasury/models/legal_entity.rb,
sig/modern_treasury/models/legal_entity.rbs

Overview

See Also:

• ModernTreasury::Resources::LegalEntities#create

Defined Under Namespace

Modules: BusinessDesignation, LegalEntityType, LegalStructure, RiskRating, Status Classes: Address, PhoneNumber, Regulator, TermsOfUse

Instance Attribute Summary

• #addresses ⇒ Array<ModernTreasury::Models::LegalEntity::Address>

  A list of addresses for the entity.

• #bank_settings ⇒ ModernTreasury::Models::LegalEntityBankSettings^?
• #business_description ⇒ String^?

  A description of the business.

• #business_designation ⇒ Symbol, ...

  Legal designation associated with the business.

• #business_name ⇒ String^?

  The business's legal business name.

• #citizenship_country ⇒ String^?

  The country of citizenship for an individual.

• #compliance_details ⇒ Object^? deprecated Deprecated.
• #country_of_incorporation ⇒ String^?

  The country where the business is incorporated, as an ISO 3166-1 alpha-2 country code (e.g. US).

• #created_at ⇒ Time
• #date_formed ⇒ Date^?

  A business's formation date (YYYY-MM-DD).

• #date_of_birth ⇒ Date^?

  An individual's date of birth (YYYY-MM-DD).

• #discarded_at ⇒ Time^?
• #documents ⇒ Array<ModernTreasury::Models::Document>
• #doing_business_as_names ⇒ Array<String>
• #email ⇒ String^?

  The entity's primary email.

• #expected_activity_volume ⇒ Integer^?

  Monthly expected transaction volume in USD.

• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #first_name ⇒ String^?

  An individual's first name.

• #id ⇒ String
• #identifications ⇒ Array<ModernTreasury::Models::Identification>

  A list of identifications for the legal entity.

• #industry_classifications ⇒ Array<ModernTreasury::Models::LegalEntityIndustryClassification>

  A list of industry classifications for the legal entity.

• #intended_use ⇒ String^?

  A description of the intended use of the legal entity.

• #last_name ⇒ String^?

  An individual's last name.

• #legal_entity_associations ⇒ Array<ModernTreasury::Models::LegalEntityAssociation>^?

  The legal entity associations and its child legal entities.

• #legal_entity_type ⇒ Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType

  The type of legal entity.

• #legal_structure ⇒ Symbol, ...

  The business's legal structure.

• #listed_exchange ⇒ String^?

  ISO 10383 market identifier code.

• #live_mode ⇒ Boolean

  This field will be true if this object exists in the live environment or false if it exists in the test environment.

• #metadata ⇒ Hash{Symbol=>String}

  Additional data represented as key-value pairs.

• #middle_name ⇒ String^?

  An individual's middle name.

• #object ⇒ String
• #operating_jurisdictions ⇒ Array<String>

  A list of countries where the business operates, as ISO 3166-1 alpha-2 country codes (e.g. ["US", "CA"]).

• #phone_numbers ⇒ Array<ModernTreasury::Models::LegalEntity::PhoneNumber>
• #politically_exposed_person ⇒ Boolean^?

  Whether the individual is a politically exposed person.

• #preferred_name ⇒ String^?

  An individual's preferred name.

• #prefix ⇒ String^?

  An individual's prefix.

• #primary_social_media_sites ⇒ Array<String>

  A list of the entity's primary social media URLs.

• #regulators ⇒ Array<ModernTreasury::Models::LegalEntity::Regulator>^?

  Array of regulatory bodies overseeing this institution.

• #risk_rating ⇒ Symbol, ...

  The risk rating of the legal entity.

• #service_provider_legal_entity_id ⇒ String^?

  The UUID of the parent legal entity in the service provider tree.

• #status ⇒ Symbol, ...

  The activation status of the legal entity.

• #suffix ⇒ String^?

  An individual's suffix.

• #terms_of_use ⇒ ModernTreasury::Models::LegalEntity::TermsOfUse^?

  Acceptance of terms of use by the legal entity.

• #third_party_verification ⇒ ModernTreasury::Models::ThirdPartyVerification^? deprecated Deprecated.
• #third_party_verifications ⇒ Array<ModernTreasury::Models::ThirdPartyVerification>

  A list of third-party verifications run by external vendors.

• #ticker_symbol ⇒ String^?

  Stock ticker symbol for publicly traded companies.

• #updated_at ⇒ Time
• #wealth_and_employment_details ⇒ ModernTreasury::Models::LegalEntityWealthEmploymentDetail^?
• #website ⇒ String^?

  The entity's primary website URL.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(jurisdiction:, name:, registration_number:) ⇒ Object constructor

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

• #to_hash ⇒ {

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(jurisdiction:, name:, registration_number:) ⇒ Object

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

Parameters:

• jurisdiction (String) —

  The country code where the regulator operates in the ISO 3166-1 alpha-2 format (

• name (String) —

  Full name of the regulatory body.

• registration_number (String) —

  Registration or identification number with the regulator.

# File 'lib/modern_treasury/models/legal_entity.rb', line 596

Instance Attribute Details

#addresses ⇒ Array<ModernTreasury::Models::LegalEntity::Address>

A list of addresses for the entity.

Parameters:

• value (::Array[ModernTreasury::LegalEntity::Address])

Returns:

• (Array<ModernTreasury::Models::LegalEntity::Address>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 16

required :addresses, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntity::Address] }

#bank_settings ⇒ ModernTreasury::Models::LegalEntityBankSettings^?

Parameters:

• value (ModernTreasury::LegalEntityBankSettings, nil)

Returns:

• (ModernTreasury::Models::LegalEntityBankSettings, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 21

required :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true

#business_description ⇒ String^?

A description of the business.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 27

required :business_description, String, nil?: true

#business_designation ⇒ Symbol, ...

Legal designation associated with the business.

Parameters:

• value (ModernTreasury::Models::LegalEntity::business_designation, nil)

Returns:

• (Symbol, ModernTreasury::Models::LegalEntity::BusinessDesignation, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 33

required :business_designation,
enum: -> {
  ModernTreasury::LegalEntity::BusinessDesignation
},
nil?: true

#business_name ⇒ String^?

The business's legal business name.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 43

required :business_name, String, nil?: true

#citizenship_country ⇒ String^?

The country of citizenship for an individual.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 49

required :citizenship_country, String, nil?: true

#compliance_details ⇒ Object^?

Deprecated.

Parameters:

• value (top, nil)

Returns:

• (Object, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 55

required :compliance_details, ModernTreasury::Internal::Type::Unknown, nil?: true

#country_of_incorporation ⇒ String^?

The country where the business is incorporated, as an ISO 3166-1 alpha-2 country code (e.g. US).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 62

required :country_of_incorporation, String, nil?: true

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/modern_treasury/models/legal_entity.rb', line 67

required :created_at, Time

#date_formed ⇒ Date^?

A business's formation date (YYYY-MM-DD).

Parameters:

• value (Date, nil)

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 73

required :date_formed, Date, nil?: true

#date_of_birth ⇒ Date^?

An individual's date of birth (YYYY-MM-DD).

Parameters:

• value (Date, nil)

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 79

required :date_of_birth, Date, nil?: true

#discarded_at ⇒ Time^?

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 84

required :discarded_at, Time, nil?: true

#documents ⇒ Array<ModernTreasury::Models::Document>

Parameters:

• value (::Array[ModernTreasury::Document])

Returns:

• (Array<ModernTreasury::Models::Document>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 89

required :documents, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Document] }

#doing_business_as_names ⇒ Array<String>

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 94

required :doing_business_as_names, ModernTreasury::Internal::Type::ArrayOf[String]

#email ⇒ String^?

The entity's primary email.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 100

required :email, String, nil?: true

#expected_activity_volume ⇒ Integer^?

Monthly expected transaction volume in USD.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 106

required :expected_activity_volume, Integer, nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 112

required :external_id, String, nil?: true

#first_name ⇒ String^?

An individual's first name.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 118

required :first_name, String, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/modern_treasury/models/legal_entity.rb', line 10

required :id, String

#identifications ⇒ Array<ModernTreasury::Models::Identification>

A list of identifications for the legal entity.

Parameters:

• value (::Array[ModernTreasury::Identification])

Returns:

• (Array<ModernTreasury::Models::Identification>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 124

required :identifications, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Identification] }

#industry_classifications ⇒ Array<ModernTreasury::Models::LegalEntityIndustryClassification>

A list of industry classifications for the legal entity.

Parameters:

• value (::Array[ModernTreasury::LegalEntityIndustryClassification])

Returns:

• (Array<ModernTreasury::Models::LegalEntityIndustryClassification>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 130

required :industry_classifications,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }

#intended_use ⇒ String^?

A description of the intended use of the legal entity.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 137

required :intended_use, String, nil?: true

#last_name ⇒ String^?

An individual's last name.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 143

required :last_name, String, nil?: true

#legal_entity_associations ⇒ Array<ModernTreasury::Models::LegalEntityAssociation>^?

The legal entity associations and its child legal entities.

Parameters:

• value (::Array[ModernTreasury::LegalEntityAssociation], nil)

Returns:

• (Array<ModernTreasury::Models::LegalEntityAssociation>, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 307

optional :legal_entity_associations,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation] },
nil?: true

#legal_entity_type ⇒ Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType

The type of legal entity.

Parameters:

• value (ModernTreasury::Models::LegalEntity::legal_entity_type)

Returns:

• (Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType)

# File 'lib/modern_treasury/models/legal_entity.rb', line 149

required :legal_entity_type, enum: -> { ModernTreasury::LegalEntity::LegalEntityType }

#legal_structure ⇒ Symbol, ...

The business's legal structure.

Parameters:

• value (ModernTreasury::Models::LegalEntity::legal_structure, nil)

Returns:

• (Symbol, ModernTreasury::Models::LegalEntity::LegalStructure, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 155

required :legal_structure, enum: -> { ModernTreasury::LegalEntity::LegalStructure }, nil?: true

#listed_exchange ⇒ String^?

ISO 10383 market identifier code.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 161

required :listed_exchange, String, nil?: true

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/modern_treasury/models/legal_entity.rb', line 168

required :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

Additional data represented as key-value pairs. Both the key and value must be strings.

Parameters:

• value (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String})

# File 'lib/modern_treasury/models/legal_entity.rb', line 175

required :metadata, ModernTreasury::Internal::Type::HashOf[String]

#middle_name ⇒ String^?

An individual's middle name.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 181

required :middle_name, String, nil?: true

#object ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/modern_treasury/models/legal_entity.rb', line 186

required :object, String

#operating_jurisdictions ⇒ Array<String>

A list of countries where the business operates, as ISO 3166-1 alpha-2 country codes (e.g. ["US", "CA"]).

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 193

required :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]

#phone_numbers ⇒ Array<ModernTreasury::Models::LegalEntity::PhoneNumber>

Parameters:

• value (::Array[ModernTreasury::LegalEntity::PhoneNumber])

Returns:

• (Array<ModernTreasury::Models::LegalEntity::PhoneNumber>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 198

required :phone_numbers,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntity::PhoneNumber] }

#politically_exposed_person ⇒ Boolean^?

Whether the individual is a politically exposed person.

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 205

required :politically_exposed_person, ModernTreasury::Internal::Type::Boolean, nil?: true

#preferred_name ⇒ String^?

An individual's preferred name.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 211

required :preferred_name, String, nil?: true

#prefix ⇒ String^?

An individual's prefix.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 217

required :prefix, String, nil?: true

#primary_social_media_sites ⇒ Array<String>

A list of the entity's primary social media URLs.

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 223

required :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]

#regulators ⇒ Array<ModernTreasury::Models::LegalEntity::Regulator>^?

Array of regulatory bodies overseeing this institution.

Parameters:

• value (::Array[ModernTreasury::LegalEntity::Regulator], nil)

Returns:

• (Array<ModernTreasury::Models::LegalEntity::Regulator>, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 229

required :regulators,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntity::Regulator] },
nil?: true

#risk_rating ⇒ Symbol, ...

The risk rating of the legal entity. One of low, medium, high.

Parameters:

• value (ModernTreasury::Models::LegalEntity::risk_rating, nil)

Returns:

• (Symbol, ModernTreasury::Models::LegalEntity::RiskRating, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 237

required :risk_rating, enum: -> { ModernTreasury::LegalEntity::RiskRating }, nil?: true

#service_provider_legal_entity_id ⇒ String^?

The UUID of the parent legal entity in the service provider tree.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 243

required :service_provider_legal_entity_id, String, nil?: true

#status ⇒ Symbol, ...

The activation status of the legal entity. One of pending, active, suspended, or denied.

Parameters:

• value (ModernTreasury::Models::LegalEntity::status, nil)

Returns:

• (Symbol, ModernTreasury::Models::LegalEntity::Status, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 250

required :status, enum: -> { ModernTreasury::LegalEntity::Status }, nil?: true

#suffix ⇒ String^?

An individual's suffix.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 256

required :suffix, String, nil?: true

#terms_of_use ⇒ ModernTreasury::Models::LegalEntity::TermsOfUse^?

Acceptance of terms of use by the legal entity.

Parameters:

• value (ModernTreasury::LegalEntity::TermsOfUse, nil)

Returns:

• (ModernTreasury::Models::LegalEntity::TermsOfUse, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 262

required :terms_of_use, -> { ModernTreasury::LegalEntity::TermsOfUse }, nil?: true

#third_party_verification ⇒ ModernTreasury::Models::ThirdPartyVerification^?

Deprecated.

Deprecated. Use third_party_verifications instead.

Parameters:

• value (ModernTreasury::ThirdPartyVerification, nil)

Returns:

• (ModernTreasury::Models::ThirdPartyVerification, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 270

required :third_party_verification, -> { ModernTreasury::ThirdPartyVerification }, nil?: true

#third_party_verifications ⇒ Array<ModernTreasury::Models::ThirdPartyVerification>

A list of third-party verifications run by external vendors.

Parameters:

• value (::Array[ModernTreasury::ThirdPartyVerification])

Returns:

• (Array<ModernTreasury::Models::ThirdPartyVerification>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 276

required :third_party_verifications,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ThirdPartyVerification] }

#ticker_symbol ⇒ String^?

Stock ticker symbol for publicly traded companies.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 283

required :ticker_symbol, String, nil?: true

#updated_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/modern_treasury/models/legal_entity.rb', line 288

required :updated_at, Time

#wealth_and_employment_details ⇒ ModernTreasury::Models::LegalEntityWealthEmploymentDetail^?

Parameters:

• value (ModernTreasury::LegalEntityWealthEmploymentDetail, nil)

Returns:

• (ModernTreasury::Models::LegalEntityWealthEmploymentDetail, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 293

required :wealth_and_employment_details,
-> { ModernTreasury::LegalEntityWealthEmploymentDetail },
nil?: true

#website ⇒ String^?

The entity's primary website URL.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity.rb', line 301

required :website, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/legal_entity.rb', line 539

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/legal_entity.rbs', line 207

def to_hash: -> {