Class: Dataleon::Models::Individual

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dataleon::Models::Individual

Defined in:

lib/dataleon/models/individual.rb

Overview

See Also:

• Resources::Individuals#create

Defined Under Namespace

Classes: AmlSuspicion, Certificat, IdentityCard, Person, Property, Risk, Tag, TechnicalData

Instance Attribute Summary

• #aml_suspicions ⇒ Array<Dataleon::Models::Individual::AmlSuspicion>^?

  List of AML (Anti-Money Laundering) suspicion entries linked to the individual.

• #auth_url ⇒ String^?

  URL to authenticate the individual, usually for document signing or onboarding.

• #certificat ⇒ Dataleon::Models::Individual::Certificat^?

  Digital certificate associated with the individual, if any.

• #checks ⇒ Array<Dataleon::Models::Check>^?

  List of verification or validation checks applied to the individual.

• #created_at ⇒ Time^?

  Timestamp of the individual’s creation in ISO 8601 format.

• #documents ⇒ Array<Dataleon::Models::Individuals::GenericDocument>^?

  All documents submitted or associated with the individual.

• #id ⇒ String^?

  Unique identifier of the individual.

• #identity_card ⇒ Dataleon::Models::Individual::IdentityCard^?

  Reference to the individual’s identity document.

• #number ⇒ Integer^?

  Internal sequential number or reference for the individual.

• #person ⇒ Dataleon::Models::Individual::Person^?

  Personal details of the individual, such as name, date of birth, and contact info.

• #portal_url ⇒ String^?

  Admin or internal portal URL for viewing the individual’s details.

• #properties ⇒ Array<Dataleon::Models::Individual::Property>^?

  Custom key-value metadata fields associated with the individual.

• #risk ⇒ Dataleon::Models::Individual::Risk^?

  Risk assessment associated with the individual.

• #source_id ⇒ String^?

  Optional identifier indicating the source of the individual record.

• #state ⇒ String^?

  Current operational state in the workflow (e.g., WAITING, IN_PROGRESS, COMPLETED).

• #status ⇒ String^?

  Overall processing status of the individual (e.g., rejected, need_review, approved).

• #tags ⇒ Array<Dataleon::Models::Individual::Tag>^?

  List of tags assigned to the individual for categorization or metadata purposes.

• #technical_data ⇒ Dataleon::Models::Individual::TechnicalData^?

  Technical metadata related to the request (e.g., QR code settings, language).

• #webview_url ⇒ String^?

  Public-facing webview URL for the individual’s identification process.

• #workspace_id ⇒ String^?

  Identifier of the workspace to which the individual belongs.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(key: nil, private: nil, type: nil, value: nil) ⇒ Object constructor

  Represents a key-value metadata tag that can be associated with entities such as individuals or companies.

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(key: nil, private: nil, type: nil, value: nil) ⇒ Object

Represents a key-value metadata tag that can be associated with entities such as individuals or companies.

Parameters:

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

  Name of the tag used to identify the metadata field.

• private (Boolean) (defaults to: nil) —

  Indicates whether the tag is private (not visible to external users).

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

  Data type of the tag value (e.g., “string”, “number”, “boolean”).

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

  Value assigned to the tag.

# File 'lib/dataleon/models/individual.rb', line 314

Instance Attribute Details

#aml_suspicions ⇒ Array<Dataleon::Models::Individual::AmlSuspicion>^?

List of AML (Anti-Money Laundering) suspicion entries linked to the individual.

Returns:

• (Array<Dataleon::Models::Individual::AmlSuspicion>, nil)

# File 'lib/dataleon/models/individual.rb', line 17

optional :aml_suspicions, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individual::AmlSuspicion] }

#auth_url ⇒ String^?

URL to authenticate the individual, usually for document signing or onboarding.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 23

optional :auth_url, String

#certificat ⇒ Dataleon::Models::Individual::Certificat^?

Digital certificate associated with the individual, if any.

Returns:

• (Dataleon::Models::Individual::Certificat, nil)

# File 'lib/dataleon/models/individual.rb', line 29

optional :certificat, -> { Dataleon::Individual::Certificat }

#checks ⇒ Array<Dataleon::Models::Check>^?

List of verification or validation checks applied to the individual.

Returns:

• (Array<Dataleon::Models::Check>, nil)

# File 'lib/dataleon/models/individual.rb', line 35

optional :checks, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Check] }

#created_at ⇒ Time^?

Timestamp of the individual’s creation in ISO 8601 format.

Returns:

• (Time, nil)

# File 'lib/dataleon/models/individual.rb', line 41

optional :created_at, Time

#documents ⇒ Array<Dataleon::Models::Individuals::GenericDocument>^?

All documents submitted or associated with the individual.

Returns:

• (Array<Dataleon::Models::Individuals::GenericDocument>, nil)

# File 'lib/dataleon/models/individual.rb', line 47

optional :documents, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::GenericDocument] }

#id ⇒ String^?

Unique identifier of the individual.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 11

optional :id, String

#identity_card ⇒ Dataleon::Models::Individual::IdentityCard^?

Reference to the individual’s identity document.

Returns:

• (Dataleon::Models::Individual::IdentityCard, nil)

# File 'lib/dataleon/models/individual.rb', line 53

optional :identity_card, -> { Dataleon::Individual::IdentityCard }

#number ⇒ Integer^?

Internal sequential number or reference for the individual.

Returns:

• (Integer, nil)

# File 'lib/dataleon/models/individual.rb', line 59

optional :number, Integer

#person ⇒ Dataleon::Models::Individual::Person^?

Personal details of the individual, such as name, date of birth, and contact info.

Returns:

• (Dataleon::Models::Individual::Person, nil)

# File 'lib/dataleon/models/individual.rb', line 66

optional :person, -> { Dataleon::Individual::Person }

#portal_url ⇒ String^?

Admin or internal portal URL for viewing the individual’s details.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 72

optional :portal_url, String

#properties ⇒ Array<Dataleon::Models::Individual::Property>^?

Custom key-value metadata fields associated with the individual.

Returns:

• (Array<Dataleon::Models::Individual::Property>, nil)

# File 'lib/dataleon/models/individual.rb', line 78

optional :properties, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individual::Property] }

#risk ⇒ Dataleon::Models::Individual::Risk^?

Risk assessment associated with the individual.

Returns:

• (Dataleon::Models::Individual::Risk, nil)

# File 'lib/dataleon/models/individual.rb', line 84

optional :risk, -> { Dataleon::Individual::Risk }

#source_id ⇒ String^?

Optional identifier indicating the source of the individual record.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 90

optional :source_id, String

#state ⇒ String^?

Current operational state in the workflow (e.g., WAITING, IN_PROGRESS, COMPLETED).

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 97

optional :state, String

#status ⇒ String^?

Overall processing status of the individual (e.g., rejected, need_review, approved).

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 104

optional :status, String

#tags ⇒ Array<Dataleon::Models::Individual::Tag>^?

List of tags assigned to the individual for categorization or metadata purposes.

Returns:

• (Array<Dataleon::Models::Individual::Tag>, nil)

# File 'lib/dataleon/models/individual.rb', line 110

optional :tags, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individual::Tag] }

#technical_data ⇒ Dataleon::Models::Individual::TechnicalData^?

Technical metadata related to the request (e.g., QR code settings, language).

Returns:

• (Dataleon::Models::Individual::TechnicalData, nil)

# File 'lib/dataleon/models/individual.rb', line 116

optional :technical_data, -> { Dataleon::Individual::TechnicalData }

#webview_url ⇒ String^?

Public-facing webview URL for the individual’s identification process.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 122

optional :webview_url, String

#workspace_id ⇒ String^?

Identifier of the workspace to which the individual belongs.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individual.rb', line 128

optional :workspace_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/dataleon/models/individual.rb', line 289