Class: Increase::Models::EntityCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: Structure Classes: Corporation, GovernmentAuthority, Joint, NaturalPerson, RiskRating, SupplementalDocument, ThirdPartyVerification, Trust

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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

Parameters:

  • file_id (String) (defaults to: ) —

    The identifier of the File containing the document.




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

Instance Attribute Details

#corporation ⇒ Increase::Models::EntityCreateParams::Corporation?

Details of the corporation entity to create. Required if ‘structure` is equal to `corporation`.

Returns:



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

optional :corporation, -> { Increase::EntityCreateParams::Corporation }

#description ⇒ String?

The description you choose to give the entity.

Returns:

  • (String, nil) 


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

optional :description, String

#government_authority ⇒ Increase::Models::EntityCreateParams::GovernmentAuthority?

Details of the Government Authority entity to create. Required if ‘structure` is equal to `government_authority`.

Returns:



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

optional :government_authority, -> { Increase::EntityCreateParams::GovernmentAuthority }

#joint ⇒ Increase::Models::EntityCreateParams::Joint?

Details of the joint entity to create. Required if ‘structure` is equal to `joint`.

Returns:



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

optional :joint, -> { Increase::EntityCreateParams::Joint }

#natural_person ⇒ Increase::Models::EntityCreateParams::NaturalPerson?

Details of the natural person entity to create. Required if ‘structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods.

Returns:



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

optional :natural_person, -> { Increase::EntityCreateParams::NaturalPerson }

#risk_rating ⇒ Increase::Models::EntityCreateParams::RiskRating?

An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.

Returns:



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

optional :risk_rating, -> { Increase::EntityCreateParams::RiskRating }

#structure ⇒ Symbol, Increase::Models::EntityCreateParams::Structure

The type of Entity to create.

Returns:



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

required :structure, enum: -> { Increase::EntityCreateParams::Structure }

#supplemental_documents ⇒ Array<Increase::Models::EntityCreateParams::SupplementalDocument>?

Additional documentation associated with the entity.

Returns:



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

optional :supplemental_documents,
-> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::SupplementalDocument] }

#third_party_verification ⇒ Increase::Models::EntityCreateParams::ThirdPartyVerification?

If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.

Returns:



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

optional :third_party_verification, -> { Increase::EntityCreateParams::ThirdPartyVerification }

#trust ⇒ Increase::Models::EntityCreateParams::Trust?

Details of the trust entity to create. Required if ‘structure` is equal to `trust`.

Returns:



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

optional :trust, -> { Increase::EntityCreateParams::Trust }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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