Class: Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/increase/models/entity_create_beneficial_owner_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Method Classes: DriversLicense, Other, Passport

Instance Attribute Summary collapse

Class Method 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(country: , description: , file_id: , back_file_id: nil, expiration_date: nil) ⇒ Object

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

Information about the identification document provided. Required if ‘method` is equal to `other`.

Parameters:

  • country (String) (defaults to: ) —

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

  • description (String) (defaults to: ) —

    A description of the document submitted.

  • file_id (String) (defaults to: ) —

    The identifier of the File containing the front of the document.

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

    The identifier of the File containing the back of the document. Not every docume

  • expiration_date (Date) (defaults to: nil) —

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




# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 219

Instance Attribute Details

#drivers_license ⇒ Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense?

Information about the United States driver’s license used for identification. Required if ‘method` is equal to `drivers_license`.

Returns:



200
201
 
# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 200

optional :drivers_license,
-> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense }

#method_ ⇒ Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method

A method that can be used to verify the individual’s identity.

Returns:



182
183
184
185
186
 
# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 182

required :method_,
enum: -> {
  Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method
},
api_name: :method

#number ⇒ String

An identification number that can be used to verify the individual’s identity, such as a social security number.

Returns:

  • (String) 


193
 
# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 193

required :number, String

#other ⇒ Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other?

Information about the identification document provided. Required if ‘method` is equal to `other`.

Returns:



208
209
 
# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 208

optional :other,
-> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other }

#passport ⇒ Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport?

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

Returns:



216
217
 
# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 216

optional :passport,
-> { Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/entity_create_beneficial_owner_params.rb', line 257