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.

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/plaid/models/identity_verification.rb', line 109

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?(:'kyc_check')
    self.kyc_check = attributes[:'kyc_check']
  end

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

Instance Attribute Details

#client_user_id ⇒ Object

An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.



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.



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

def kyc_check
  @kyc_check
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

#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

#watchlist_screening_id ⇒ Object

ID of the associated screening.



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

def watchlist_screening_id
  @watchlist_screening_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/plaid/models/identity_verification.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/plaid/models/identity_verification.rb', line 53

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',
    :'kyc_check' => :'kyc_check',
    :'watchlist_screening_id' => :'watchlist_screening_id'
  }
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



279
280
281
 
# File 'lib/plaid/models/identity_verification.rb', line 279

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/plaid/models/identity_verification.rb', line 96

def self.openapi_nullable
  Set.new([
    :'completed_at',
    :'previous_attempt_id',
    :'shareable_url',
    :'documentary_verification',
    :'kyc_check',
    :'watchlist_screening_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/plaid/models/identity_verification.rb', line 77

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',
    :'kyc_check' => :'KYCCheckDetails',
    :'watchlist_screening_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/plaid/models/identity_verification.rb', line 246

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 &&
      kyc_check == o.kyc_check &&
      watchlist_screening_id == o.watchlist_screening_id
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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/plaid/models/identity_verification.rb', line 309

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/plaid/models/identity_verification.rb', line 380

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/plaid/models/identity_verification.rb', line 286

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


266
267
268
 
# File 'lib/plaid/models/identity_verification.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/plaid/models/identity_verification.rb', line 272

def hash
  [id, client_user_id, created_at, completed_at, previous_attempt_id, shareable_url, template, user, status, steps, documentary_verification, kyc_check, watchlist_screening_id].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



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
 
# File 'lib/plaid/models/identity_verification.rb', line 177

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 @client_user_id.to_s.length < 1
    invalid_properties.push('invalid value for "client_user_id", the character length must be great than or equal to 1.')
  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



356
357
358
 
# File 'lib/plaid/models/identity_verification.rb', line 356

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



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

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



350
351
352
 
# File 'lib/plaid/models/identity_verification.rb', line 350

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



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/plaid/models/identity_verification.rb', line 217

def valid?
  return false if @id.nil?
  return false if @client_user_id.nil?
  return false if @client_user_id.to_s.length < 1
  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