Class: Increase::Models::EntityCreateParams::NaturalPerson

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_create_params.rb

Defined Under Namespace

Classes: Address, Identification

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(city: , line1: , state: , zip: , line2: nil) ⇒ Object

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

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

Parameters:

  • city (String) (defaults to: ) —

    The city of the address.

  • line1 (String) (defaults to: ) —

    The first line of the address. This is usually the street number and street.

  • state (String) (defaults to: ) —

    The two-letter United States Postal Service (USPS) abbreviation for the state of

  • zip (String) (defaults to: ) —

    The ZIP code of the address.

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

    The second line of the address. This might be the floor or room number.




# File 'lib/increase/models/entity_create_params.rb', line 1171

Instance Attribute Details

#address ⇒ Increase::Models::EntityCreateParams::NaturalPerson::Address

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

Returns:



1142
 
# File 'lib/increase/models/entity_create_params.rb', line 1142

required :address, -> { Increase::EntityCreateParams::NaturalPerson::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) 


1169
 
# File 'lib/increase/models/entity_create_params.rb', line 1169

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

#date_of_birth ⇒ Date

The person’s date of birth in YYYY-MM-DD format.

Returns:

  • (Date) 


1148
 
# File 'lib/increase/models/entity_create_params.rb', line 1148

required :date_of_birth, Date

#identification ⇒ Increase::Models::EntityCreateParams::NaturalPerson::Identification

A means of verifying the person’s identity.

Returns:



1154
 
# File 'lib/increase/models/entity_create_params.rb', line 1154

required :identification, -> { Increase::EntityCreateParams::NaturalPerson::Identification }

#name ⇒ String

The person’s legal name.

Returns:

  • (String) 


1160
 
# File 'lib/increase/models/entity_create_params.rb', line 1160

required :name, String