Class: Stripe::Identity::VerificationSession::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/identity/verification_session.rb

Defined Under Namespace

Classes: Options, ProvidedDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(client_reference_id: nil, expand: nil, metadata: nil, options: nil, provided_details: nil, related_customer: nil, return_url: nil, type: nil, verification_flow: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 283

def initialize(
  client_reference_id: nil,
  expand: nil,
  metadata: nil,
  options: nil,
  provided_details: nil,
  related_customer: nil,
  return_url: nil,
  type: nil,
  verification_flow: nil
)
  @client_reference_id = client_reference_id
  @expand = expand
  @metadata = metadata
  @options = options
  @provided_details = provided_details
  @related_customer = related_customer
  @return_url = return_url
  @type = type
  @verification_flow = verification_flow
end

Instance Attribute Details

#client_reference_id ⇒ Object

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.



257
258
259
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 257

def client_reference_id
  @client_reference_id
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



260
261
262
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 260

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



263
264
265
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 263

def metadata
  @metadata
end

#options ⇒ Object

A set of options for the session’s verification checks.



266
267
268
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 266

def options
  @options
end

#provided_details ⇒ Object

Details provided about the user being verified. These details may be shown to the user.



269
270
271
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 269

def provided_details
  @provided_details
end

#related_customer ⇒ Object

Token referencing a Customer resource.



272
273
274
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 272

def related_customer
  @related_customer
end

#return_url ⇒ Object

The URL that the user will be redirected to upon completing the verification flow.



275
276
277
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 275

def return_url
  @return_url
end

#type ⇒ Object

The type of [verification check](stripe.com/docs/identity/verification-checks) to be performed. You must provide a ‘type` if not passing `verification_flow`.



278
279
280
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 278

def type
  @type
end

#verification_flow ⇒ Object

The ID of a verification flow from the Dashboard. See docs.stripe.com/identity/verification-flows.



281
282
283
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 281

def verification_flow
  @verification_flow
end