Class: Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification

Defined in:

lib/increase/models/entity_create_params.rb,
sig/increase/models/entity_create_params.rbs

Overview

See Also:

• Increase::Models::EntityCreateParams::Trust::Trustee::Individual#identification

Defined Under Namespace

Modules: Method Classes: DriversLicense, Other, Passport

Instance Attribute Summary

• #drivers_license ⇒ Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense^?

  Information about the United States driver's license used for identification.

• #method_ ⇒ Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method

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

• #number ⇒ String

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

• #other ⇒ Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other^?

  Information about the identification document provided.

• #passport ⇒ Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport^?

  Information about the passport used for identification.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) ⇒ Object constructor

  Information about the identification document provided.

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

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

Parameters:

• The two-character ISO 3166-1 code representing the country that issued the document (e.g., US).

• A description of the document submitted.

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

• (defaults to: nil)

  The identifier of the File containing the back of the document. Not every document has a reverse side.

• (defaults to: nil)

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

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

Instance Attribute Details

#drivers_license ⇒ Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense^?

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

Returns:

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

optional :drivers_license,
-> { Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense }

#method_ ⇒ Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method

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

Defaults to social_security_number.

Parameters:

Returns:

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

required :method_,
enum: -> {
  Increase::EntityCreateParams::Trust::Trustee::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. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.

Parameters:

Returns:

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

required :number, String

#other ⇒ Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other^?

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

Returns:

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

optional :other, -> { Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other }

#passport ⇒ Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport^?

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

Returns:

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

optional :passport,
-> { Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

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

Instance Method Details

#to_hash ⇒ {

Returns:

# File 'sig/increase/models/entity_create_params.rbs', line 1911

def to_hash: -> {