Class: ModernTreasury::Models::LegalEntityCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/legal_entity_create_params.rb

Overview

See Also:

• Resources::LegalEntities#create

Defined Under Namespace

Modules: LegalEntityType, LegalStructure, RiskRating Classes: Document, PhoneNumber, Regulator

Instance Attribute Summary

• #addresses ⇒ Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>^?

  A list of addresses for the entity.

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

  A description of 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.
• #connection_id ⇒ String^?

  The connection ID for the connection the legal entity is associated with.

• #country_of_incorporation ⇒ String^?

  The country code where the business is incorporated in the ISO 3166-1 alpha-2 or alpha-3 formats.

• #date_formed ⇒ Date^?

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

• #date_of_birth ⇒ Date^?

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

• #documents ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::Document>^?

  A list of documents to attach to the legal entity (e.g. articles of incorporation, certificate of good standing, proof of address).

• #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.

• #identifications ⇒ Array<ModernTreasury::Models::IdentificationCreateRequest>^?

  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::LegalEntityAssociationInlineCreate>^?

  The legal entity associations and its child legal entities.

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

  The type of legal entity.

• #legal_structure ⇒ Symbol, ...

  The business’s legal structure.

• #listed_exchange ⇒ String^?

  ISO 10383 market identifier code.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional data represented as key-value pairs.

• #middle_name ⇒ String^?

  An individual’s middle name.

• #operating_jurisdictions ⇒ Array<String>^?

  A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 codes).

• #phone_numbers ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::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 primary social media URLs for the business.

• #regulators ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::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.

• #suffix ⇒ String^?

  An individual’s suffix.

• #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.

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

  The entity’s primary website URL.

Attributes included from Internal::Type::RequestParameters

#request_options

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.

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(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_create_params.rb', line 280

Instance Attribute Details

#addresses ⇒ Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>^?

A list of addresses for the entity.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 20

optional :addresses,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAddressCreateRequest] }

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

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 26

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

#business_description ⇒ String^?

A description of the business.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 32

optional :business_description, String, nil?: true

#business_name ⇒ String^?

The business’s legal business name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 38

optional :business_name, String, nil?: true

#citizenship_country ⇒ String^?

The country of citizenship for an individual.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 44

optional :citizenship_country, String, nil?: true

#compliance_details ⇒ Object^?

Deprecated.

Returns:

• (Object, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 50

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

#connection_id ⇒ String^?

The connection ID for the connection the legal entity is associated with. Defaults to the id of the connection designated with an is_default value of true or the id of an existing operational connection if only one is available. Pass in a value of null to prevent the connection from being associated with the legal entity.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 60

optional :connection_id, String, nil?: true

#country_of_incorporation ⇒ String^?

The country code where the business is incorporated in the ISO 3166-1 alpha-2 or alpha-3 formats.

Returns:

• (String, nil)

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

optional :country_of_incorporation, String, nil?: true

#date_formed ⇒ Date^?

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

Returns:

• (Date, nil)

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

optional :date_formed, Date, nil?: true

#date_of_birth ⇒ Date^?

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

Returns:

• (Date, nil)

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

optional :date_of_birth, Date, nil?: true

#documents ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::Document>^?

A list of documents to attach to the legal entity (e.g. articles of incorporation, certificate of good standing, proof of address).

Returns:

• (Array<ModernTreasury::Models::LegalEntityCreateParams::Document>, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 86

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

#doing_business_as_names ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 92

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

#email ⇒ String^?

The entity’s primary email.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 98

optional :email, String, nil?: true

#expected_activity_volume ⇒ Integer^?

Monthly expected transaction volume in USD.

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 104

optional :expected_activity_volume, Integer, nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 110

optional :external_id, String, nil?: true

#first_name ⇒ String^?

An individual’s first name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 116

optional :first_name, String, nil?: true

#identifications ⇒ Array<ModernTreasury::Models::IdentificationCreateRequest>^?

A list of identifications for the legal entity.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 122

optional :identifications,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::IdentificationCreateRequest] }

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

A list of industry classifications for the legal entity.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 129

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

#intended_use ⇒ String^?

A description of the intended use of the legal entity.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 136

optional :intended_use, String, nil?: true

#last_name ⇒ String^?

An individual’s last name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 142

optional :last_name, String, nil?: true

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

The legal entity associations and its child legal entities.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 148

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

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

The type of legal entity.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 14

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

#legal_structure ⇒ Symbol, ...

The business’s legal structure.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 158

optional :legal_structure,
enum: -> { ModernTreasury::LegalEntityCreateParams::LegalStructure },
nil?: true

#listed_exchange ⇒ String^?

ISO 10383 market identifier code.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 166

optional :listed_exchange, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

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

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 173

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

#middle_name ⇒ String^?

An individual’s middle name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 179

optional :middle_name, String, nil?: true

#operating_jurisdictions ⇒ Array<String>^?

A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 codes).

Returns:

• (Array<String>, nil)

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

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

#phone_numbers ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>^?

Returns:

• (Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 191

optional :phone_numbers,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityCreateParams::PhoneNumber] }

#politically_exposed_person ⇒ Boolean^?

Whether the individual is a politically exposed person.

Returns:

• (Boolean, nil)

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

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

#preferred_name ⇒ String^?

An individual’s preferred name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 204

optional :preferred_name, String, nil?: true

#prefix ⇒ String^?

An individual’s prefix.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 210

optional :prefix, String, nil?: true

#primary_social_media_sites ⇒ Array<String>^?

A list of primary social media URLs for the business.

Returns:

• (Array<String>, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 216

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

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

Array of regulatory bodies overseeing this institution.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 222

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

#risk_rating ⇒ Symbol, ...

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

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 232

optional :risk_rating, enum: -> { ModernTreasury::LegalEntityCreateParams::RiskRating }, nil?: true

#service_provider_legal_entity_id ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 238

optional :service_provider_legal_entity_id, String, nil?: true

#suffix ⇒ String^?

An individual’s suffix.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 244

optional :suffix, String, nil?: true

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

Deprecated.

Deprecated. Use ‘third_party_verifications` instead.

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 252

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

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

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

Returns:

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

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 258

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

#ticker_symbol ⇒ String^?

Stock ticker symbol for publicly traded companies.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 265

optional :ticker_symbol, String, nil?: true

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

Returns:

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

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

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

#website ⇒ String^?

The entity’s primary website URL.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 278

optional :website, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 375