Class: Plaid::IdentityVerification

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/identity_verification.rb

Overview

A identity verification attempt represents a customer’s attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentityVerification

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



169
170
171
172
173
174
175
176
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
 
# File 'lib/plaid/models/identity_verification.rb', line 169

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IdentityVerification` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IdentityVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'client_user_id')
    self.client_user_id = attributes[:'client_user_id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end

  if attributes.key?(:'previous_attempt_id')
    self.previous_attempt_id = attributes[:'previous_attempt_id']
  end

  if attributes.key?(:'shareable_url')
    self.shareable_url = attributes[:'shareable_url']
  end

  if attributes.key?(:'template')
    self.template = attributes[:'template']
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'steps')
    self.steps = attributes[:'steps']
  end

  if attributes.key?(:'documentary_verification')
    self.documentary_verification = attributes[:'documentary_verification']
  end

  if attributes.key?(:'selfie_check')
    self.selfie_check = attributes[:'selfie_check']
  end

  if attributes.key?(:'kyc_check')
    self.kyc_check = attributes[:'kyc_check']
  end

  if attributes.key?(:'risk_check')
    self.risk_check = attributes[:'risk_check']
  end

  if attributes.key?(:'verify_sms')
    self.verify_sms = attributes[:'verify_sms']
  end

  if attributes.key?(:'watchlist_screening_id')
    self.watchlist_screening_id = attributes[:'watchlist_screening_id']
  end

  if attributes.key?(:'beacon_user_id')
    self.beacon_user_id = attributes[:'beacon_user_id']
  end

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'redacted_at')
    self.redacted_at = attributes[:'redacted_at']
  end

  if attributes.key?(:'latest_scored_protect_event')
    self.latest_scored_protect_event = attributes[:'latest_scored_protect_event']
  end
end

Instance Attribute Details

#beacon_user_id ⇒ Object

ID of the associated Beacon User.



59
60
61
 
# File 'lib/plaid/models/identity_verification.rb', line 59

def beacon_user_id
  @beacon_user_id
end

#client_user_id ⇒ Object

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the ‘/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.



23
24
25
 
# File 'lib/plaid/models/identity_verification.rb', line 23

def client_user_id
  @client_user_id
end

#completed_at ⇒ Object

An ISO8601 formatted timestamp.



29
30
31
 
# File 'lib/plaid/models/identity_verification.rb', line 29

def completed_at
  @completed_at
end

#created_at ⇒ Object

An ISO8601 formatted timestamp.



26
27
28
 
# File 'lib/plaid/models/identity_verification.rb', line 26

def created_at
  @created_at
end

#documentary_verification ⇒ Object

Returns the value of attribute documentary_verification.



45
46
47
 
# File 'lib/plaid/models/identity_verification.rb', line 45

def documentary_verification
  @documentary_verification
end

#id ⇒ Object

ID of the associated Identity Verification attempt.



20
21
22
 
# File 'lib/plaid/models/identity_verification.rb', line 20

def id
  @id
end

#kyc_check ⇒ Object

Returns the value of attribute kyc_check.



49
50
51
 
# File 'lib/plaid/models/identity_verification.rb', line 49

def kyc_check
  @kyc_check
end

#latest_scored_protect_event ⇒ Object

Returns the value of attribute latest_scored_protect_event.



67
68
69
 
# File 'lib/plaid/models/identity_verification.rb', line 67

def latest_scored_protect_event
  @latest_scored_protect_event
end

#previous_attempt_id ⇒ Object

The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attempt.



32
33
34
 
# File 'lib/plaid/models/identity_verification.rb', line 32

def previous_attempt_id
  @previous_attempt_id
end

#redacted_at ⇒ Object

An ISO8601 formatted timestamp.



65
66
67
 
# File 'lib/plaid/models/identity_verification.rb', line 65

def redacted_at
  @redacted_at
end

#risk_check ⇒ Object

Returns the value of attribute risk_check.



51
52
53
 
# File 'lib/plaid/models/identity_verification.rb', line 51

def risk_check
  @risk_check
end

#selfie_check ⇒ Object

Returns the value of attribute selfie_check.



47
48
49
 
# File 'lib/plaid/models/identity_verification.rb', line 47

def selfie_check
  @selfie_check
end

#shareable_url ⇒ Object

A shareable URL that can be sent directly to the user to complete verification



35
36
37
 
# File 'lib/plaid/models/identity_verification.rb', line 35

def shareable_url
  @shareable_url
end

#status ⇒ Object

Returns the value of attribute status.



41
42
43
 
# File 'lib/plaid/models/identity_verification.rb', line 41

def status
  @status
end

#steps ⇒ Object

Returns the value of attribute steps.



43
44
45
 
# File 'lib/plaid/models/identity_verification.rb', line 43

def steps
  @steps
end

#template ⇒ Object

Returns the value of attribute template.



37
38
39
 
# File 'lib/plaid/models/identity_verification.rb', line 37

def template
  @template
end

#user ⇒ Object

Returns the value of attribute user.



39
40
41
 
# File 'lib/plaid/models/identity_verification.rb', line 39

def user
  @user
end

#user_id ⇒ Object

A unique user identifier, created by ‘/user/create`. All integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [new user APIs](plaid.com/docs/api/user/user-apis).



62
63
64
 
# File 'lib/plaid/models/identity_verification.rb', line 62

def user_id
  @user_id
end

#verify_sms ⇒ Object

Returns the value of attribute verify_sms.



53
54
55
 
# File 'lib/plaid/models/identity_verification.rb', line 53

def verify_sms
  @verify_sms
end

#watchlist_screening_id ⇒ Object

ID of the associated screening.



56
57
58
 
# File 'lib/plaid/models/identity_verification.rb', line 56

def watchlist_screening_id
  @watchlist_screening_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/plaid/models/identity_verification.rb', line 118

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/plaid/models/identity_verification.rb', line 92

def self.attribute_map
  {
    :'id' => :'id',
    :'client_user_id' => :'client_user_id',
    :'created_at' => :'created_at',
    :'completed_at' => :'completed_at',
    :'previous_attempt_id' => :'previous_attempt_id',
    :'shareable_url' => :'shareable_url',
    :'template' => :'template',
    :'user' => :'user',
    :'status' => :'status',
    :'steps' => :'steps',
    :'documentary_verification' => :'documentary_verification',
    :'selfie_check' => :'selfie_check',
    :'kyc_check' => :'kyc_check',
    :'risk_check' => :'risk_check',
    :'verify_sms' => :'verify_sms',
    :'watchlist_screening_id' => :'watchlist_screening_id',
    :'beacon_user_id' => :'beacon_user_id',
    :'user_id' => :'user_id',
    :'redacted_at' => :'redacted_at',
    :'latest_scored_protect_event' => :'latest_scored_protect_event'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



353
354
355
 
# File 'lib/plaid/models/identity_verification.rb', line 353

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/plaid/models/identity_verification.rb', line 149

def self.openapi_nullable
  Set.new([
    :'completed_at',
    :'previous_attempt_id',
    :'shareable_url',
    :'documentary_verification',
    :'selfie_check',
    :'kyc_check',
    :'risk_check',
    :'verify_sms',
    :'watchlist_screening_id',
    :'beacon_user_id',
    :'user_id',
    :'redacted_at',
    :'latest_scored_protect_event'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/plaid/models/identity_verification.rb', line 123

def self.openapi_types
  {
    :'id' => :'String',
    :'client_user_id' => :'String',
    :'created_at' => :'Time',
    :'completed_at' => :'Time',
    :'previous_attempt_id' => :'String',
    :'shareable_url' => :'String',
    :'template' => :'IdentityVerificationTemplateReference',
    :'user' => :'IdentityVerificationUserData',
    :'status' => :'IdentityVerificationStatus',
    :'steps' => :'IdentityVerificationStepSummary',
    :'documentary_verification' => :'DocumentaryVerification',
    :'selfie_check' => :'SelfieCheck',
    :'kyc_check' => :'KYCCheckDetails',
    :'risk_check' => :'RiskCheckDetails',
    :'verify_sms' => :'VerifySMSDetails',
    :'watchlist_screening_id' => :'String',
    :'beacon_user_id' => :'String',
    :'user_id' => :'String',
    :'redacted_at' => :'Time',
    :'latest_scored_protect_event' => :'IDVProtectEvent'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/plaid/models/identity_verification.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      client_user_id == o.client_user_id &&
      created_at == o.created_at &&
      completed_at == o.completed_at &&
      previous_attempt_id == o.previous_attempt_id &&
      shareable_url == o.shareable_url &&
      template == o.template &&
      user == o.user &&
      status == o.status &&
      steps == o.steps &&
      documentary_verification == o.documentary_verification &&
      selfie_check == o.selfie_check &&
      kyc_check == o.kyc_check &&
      risk_check == o.risk_check &&
      verify_sms == o.verify_sms &&
      watchlist_screening_id == o.watchlist_screening_id &&
      beacon_user_id == o.beacon_user_id &&
      user_id == o.user_id &&
      redacted_at == o.redacted_at &&
      latest_scored_protect_event == o.latest_scored_protect_event
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/plaid/models/identity_verification.rb', line 384

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/plaid/models/identity_verification.rb', line 455

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/plaid/models/identity_verification.rb', line 360

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


340
341
342
 
# File 'lib/plaid/models/identity_verification.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



346
347
348
 
# File 'lib/plaid/models/identity_verification.rb', line 346

def hash
  [id, client_user_id, created_at, completed_at, previous_attempt_id, shareable_url, template, user, status, steps, documentary_verification, selfie_check, kyc_check, risk_check, verify_sms, watchlist_screening_id, beacon_user_id, user_id, redacted_at, latest_scored_protect_event].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
293
294
295
296
 
# File 'lib/plaid/models/identity_verification.rb', line 265

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @client_user_id.nil?
    invalid_properties.push('invalid value for "client_user_id", client_user_id cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @template.nil?
    invalid_properties.push('invalid value for "template", template cannot be nil.')
  end

  if @user.nil?
    invalid_properties.push('invalid value for "user", user cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @steps.nil?
    invalid_properties.push('invalid value for "steps", steps cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



431
432
433
 
# File 'lib/plaid/models/identity_verification.rb', line 431

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/plaid/models/identity_verification.rb', line 437

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



425
426
427
 
# File 'lib/plaid/models/identity_verification.rb', line 425

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/plaid/models/identity_verification.rb', line 300

def valid?
  return false if @id.nil?
  return false if @client_user_id.nil?
  return false if @created_at.nil?
  return false if @template.nil?
  return false if @user.nil?
  return false if @status.nil?
  return false if @steps.nil?
  true
end