Class: Dataleon::Models::Individual::AmlSuspicion

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dataleon/models/individual.rb

Defined Under Namespace

Modules: Status, Type

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(caption: nil, country: nil, gender: nil, relation: nil, schema: nil, score: nil, source: nil, status: nil, type: nil) ⇒ Object

Some parameter documentations has been truncated, see Dataleon::Models::Individual::AmlSuspicion for more details.

Represents a record of suspicion raised during Anti-Money Laundering (AML) screening. Includes metadata such as risk score, origin, and linked watchlist types.

Parameters:

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

    Human-readable description or title for the suspicious finding.

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

    Country associated with the suspicion (ISO 3166-1 alpha-2 code).

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

    Gender associated with the suspicion, if applicable.

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

    Nature of the relationship between the entity and the suspicious activity (e.g.,

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

    Version of the evaluation schema or rule engine used.

  • score (Float) (defaults to: nil) —

    Risk score between 0.0 and 1 indicating the severity of the suspicion.

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

    Source system or service providing this suspicion.

  • status (Symbol, Dataleon::Models::Individual::AmlSuspicion::Status) (defaults to: nil) —

    Status of the suspicion review process. Possible values: “true_positive”, “false

  • type (Symbol, Dataleon::Models::Individual::AmlSuspicion::Type) (defaults to: nil) —

    Category of the suspicion. Possible values: “crime”, “sanction”, “pep”, “adverse



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/dataleon/models/individual.rb', line 177

class AmlSuspicion < Dataleon::Internal::Type::BaseModel
  # @!attribute caption
  #   Human-readable description or title for the suspicious finding.
  #
  #   @return [String, nil]
  optional :caption, String

  # @!attribute country
  #   Country associated with the suspicion (ISO 3166-1 alpha-2 code).
  #
  #   @return [String, nil]
  optional :country, String

  # @!attribute gender
  #   Gender associated with the suspicion, if applicable.
  #
  #   @return [String, nil]
  optional :gender, String

  # @!attribute relation
  #   Nature of the relationship between the entity and the suspicious activity (e.g.,
  #   "linked", "associated").
  #
  #   @return [String, nil]
  optional :relation, String

  # @!attribute schema
  #   Version of the evaluation schema or rule engine used.
  #
  #   @return [String, nil]
  optional :schema, String

  # @!attribute score
  #   Risk score between 0.0 and 1 indicating the severity of the suspicion.
  #
  #   @return [Float, nil]
  optional :score, Float

  # @!attribute source
  #   Source system or service providing this suspicion.
  #
  #   @return [String, nil]
  optional :source, String

  # @!attribute status
  #   Status of the suspicion review process. Possible values: "true_positive",
  #   "false_positive", "pending".
  #
  #   @return [Symbol, Dataleon::Models::Individual::AmlSuspicion::Status, nil]
  optional :status, enum: -> { Dataleon::Individual::AmlSuspicion::Status }

  # @!attribute type
  #   Category of the suspicion. Possible values: "crime", "sanction", "pep",
  #   "adverse_news", "other".
  #
  #   @return [Symbol, Dataleon::Models::Individual::AmlSuspicion::Type, nil]
  optional :type, enum: -> { Dataleon::Individual::AmlSuspicion::Type }

  # @!method initialize(caption: nil, country: nil, gender: nil, relation: nil, schema: nil, score: nil, source: nil, status: nil, type: nil)
  #   Some parameter documentations has been truncated, see
  #   {Dataleon::Models::Individual::AmlSuspicion} for more details.
  #
  #   Represents a record of suspicion raised during Anti-Money Laundering (AML)
  #   screening. Includes metadata such as risk score, origin, and linked watchlist
  #   types.
  #
  #   @param caption [String] Human-readable description or title for the suspicious finding.
  #
  #   @param country [String] Country associated with the suspicion (ISO 3166-1 alpha-2 code).
  #
  #   @param gender [String] Gender associated with the suspicion, if applicable.
  #
  #   @param relation [String] Nature of the relationship between the entity and the suspicious activity (e.g.,
  #
  #   @param schema [String] Version of the evaluation schema or rule engine used.
  #
  #   @param score [Float] Risk score between 0.0 and 1 indicating the severity of the suspicion.
  #
  #   @param source [String] Source system or service providing this suspicion.
  #
  #   @param status [Symbol, Dataleon::Models::Individual::AmlSuspicion::Status] Status of the suspicion review process. Possible values: "true_positive", "false
  #
  #   @param type [Symbol, Dataleon::Models::Individual::AmlSuspicion::Type] Category of the suspicion. Possible values: "crime", "sanction", "pep", "adverse

  # Status of the suspicion review process. Possible values: "true_positive",
  # "false_positive", "pending".
  #
  # @see Dataleon::Models::Individual::AmlSuspicion#status
  module Status
    extend Dataleon::Internal::Type::Enum

    TRUE_POSITIVE = :true_positive
    FALSE_POSITIVE = :false_positive
    PENDING = :pending

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Category of the suspicion. Possible values: "crime", "sanction", "pep",
  # "adverse_news", "other".
  #
  # @see Dataleon::Models::Individual::AmlSuspicion#type
  module Type
    extend Dataleon::Internal::Type::Enum

    CRIME = :crime
    SANCTION = :sanction
    PEP = :pep
    ADVERSE_NEWS = :adverse_news
    OTHER = :other

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#caption ⇒ String?

Human-readable description or title for the suspicious finding.

Returns:

  • (String, nil) 


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

optional :caption, String

#country ⇒ String?

Country associated with the suspicion (ISO 3166-1 alpha-2 code).

Returns:

  • (String, nil) 


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

optional :country, String

#gender ⇒ String?

Gender associated with the suspicion, if applicable.

Returns:

  • (String, nil) 


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

optional :gender, String

#relation ⇒ String?

Nature of the relationship between the entity and the suspicious activity (e.g., “linked”, “associated”).

Returns:

  • (String, nil) 


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

optional :relation, String

#schema ⇒ String?

Version of the evaluation schema or rule engine used.

Returns:

  • (String, nil) 


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

optional :schema, String

#score ⇒ Float?

Risk score between 0.0 and 1 indicating the severity of the suspicion.

Returns:

  • (Float, nil) 


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

optional :score, Float

#source ⇒ String?

Source system or service providing this suspicion.

Returns:

  • (String, nil) 


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

optional :source, String

#status ⇒ Symbol, ...

Status of the suspicion review process. Possible values: “true_positive”, “false_positive”, “pending”.

Returns:



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

optional :status, enum: -> { Dataleon::Individual::AmlSuspicion::Status }

#type ⇒ Symbol, ...

Category of the suspicion. Possible values: “crime”, “sanction”, “pep”, “adverse_news”, “other”.

Returns:



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

optional :type, enum: -> { Dataleon::Individual::AmlSuspicion::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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