Class: Increase::Models::BeneficialOwnerUpdateParams

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

Overview

See Also:

Defined Under Namespace

Modules: Prong Classes: Address, Identification

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(country:, expiration_date:, file_id:) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport for more details.

Information about the passport used for identification. Required if ‘method` is equal to `passport`.

Parameters:

  • country (String) —

    The two-character ISO 3166-1 code representing the country that issued the docum

  • expiration_date (Date) —

    The passport’s expiration date in YYYY-MM-DD format.

  • file_id (String) —

    The identifier of the File containing the passport.




# File 'lib/increase/models/beneficial_owner_update_params.rb', line 110

Instance Attribute Details

#address ⇒ Increase::Models::BeneficialOwnerUpdateParams::Address?

The individual’s physical address. Mail receiving locations like PO Boxes and PMB’s are disallowed.

Returns:



21
 
# File 'lib/increase/models/beneficial_owner_update_params.rb', line 21

optional :address, -> { Increase::BeneficialOwnerUpdateParams::Address }

#confirmed_no_us_tax_id ⇒ Boolean?

The identification method for an individual can only be a passport, driver’s license, or other document if you’ve confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).

Returns:

  • (Boolean, nil) 


30
 
# File 'lib/increase/models/beneficial_owner_update_params.rb', line 30

optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean

#entity_beneficial_owner_id ⇒ String

The identifier of the Beneficial Owner to update.

Returns:

  • (String) 


14
 
# File 'lib/increase/models/beneficial_owner_update_params.rb', line 14

required :entity_beneficial_owner_id, String

#identification ⇒ Increase::Models::BeneficialOwnerUpdateParams::Identification?

A means of verifying the person’s identity.

Returns:



36
 
# File 'lib/increase/models/beneficial_owner_update_params.rb', line 36

optional :identification, -> { Increase::BeneficialOwnerUpdateParams::Identification }

#name ⇒ String?

The individual’s legal name.

Returns:

  • (String, nil) 


42
 
# File 'lib/increase/models/beneficial_owner_update_params.rb', line 42

optional :name, String

#prongs ⇒ Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>?

Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both. Providing this replaces the beneficial owner’s current prongs.

Returns:



51
52
 
# File 'lib/increase/models/beneficial_owner_update_params.rb', line 51

optional :prongs,
-> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerUpdateParams::Prong] }