Class: Stripe::Identity::VerificationSessionCreateParams::Options::Document

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/identity/verification_session_create_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(allowed_types: nil, require_id_number: nil, require_live_capture: nil, require_matching_selfie: nil) ⇒ Document

Returns a new instance of Document.



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/stripe/params/identity/verification_session_create_params.rb', line 18

def initialize(
  allowed_types: nil,
  require_id_number: nil,
  require_live_capture: nil,
  require_matching_selfie: nil
)
  @allowed_types = allowed_types
  @require_id_number = require_id_number
  @require_live_capture = require_live_capture
  @require_matching_selfie = require_matching_selfie
end

Instance Attribute Details

#allowed_types ⇒ Object

Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.



10
11
12
 
# File 'lib/stripe/params/identity/verification_session_create_params.rb', line 10

def allowed_types
  @allowed_types
end

#require_id_number ⇒ Object

Collect an ID number and perform an [ID number check](stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.



12
13
14
 
# File 'lib/stripe/params/identity/verification_session_create_params.rb', line 12

def require_id_number
  @require_id_number
end

#require_live_capture ⇒ Object

Disable image uploads, identity document images have to be captured using the device’s camera.



14
15
16
 
# File 'lib/stripe/params/identity/verification_session_create_params.rb', line 14

def require_live_capture
  @require_live_capture
end

#require_matching_selfie ⇒ Object

Capture a face image and perform a [selfie check](stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](stripe.com/docs/identity/selfie).



16
17
18
 
# File 'lib/stripe/params/identity/verification_session_create_params.rb', line 16

def require_matching_selfie
  @require_matching_selfie
end