Class: Lithic::Models::KYCExempt

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/kyc_exempt.rb

Defined Under Namespace

Modules: KYCExemptionType, Workflow

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(address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, workflow:, business_account_token: nil, external_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::KYCExempt for more details.

Parameters:

  • address (Lithic::Models::Address) —

    KYC Exempt user’s current address - PO boxes, UPS drops, and FedEx drops are not

  • email (String) —

    The KYC Exempt user’s email

  • first_name (String) —

    The KYC Exempt user’s first name

  • kyc_exemption_type (Symbol, Lithic::Models::KYCExempt::KYCExemptionType) —

    Specifies the type of KYC Exempt user

  • last_name (String) —

    The KYC Exempt user’s last name

  • phone_number (String) —

    The KYC Exempt user’s phone number, entered in E.164 format.

  • workflow (Symbol, Lithic::Models::KYCExempt::Workflow) —

    Specifies the workflow type. This must be ‘KYC_EXEMPT’

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

    Only applicable for customers using the KYC-Exempt workflow to enroll authorized

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

    A user provided id that can be used to link an account holder with an external s




# File 'lib/lithic/models/kyc_exempt.rb', line 64

Instance Attribute Details

#address ⇒ Lithic::Models::Address

KYC Exempt user’s current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

Returns:



11
 
# File 'lib/lithic/models/kyc_exempt.rb', line 11

required :address, -> { Lithic::Address }

#business_account_token ⇒ String?

Only applicable for customers using the KYC-Exempt workflow to enroll authorized users of businesses. Pass the account_token of the enrolled business associated with the AUTHORIZED_USER in this field.

Returns:

  • (String, nil) 


55
 
# File 'lib/lithic/models/kyc_exempt.rb', line 55

optional :business_account_token, String

#email ⇒ String

The KYC Exempt user’s email

Returns:

  • (String) 


17
 
# File 'lib/lithic/models/kyc_exempt.rb', line 17

required :email, String

#external_id ⇒ String?

A user provided id that can be used to link an account holder with an external system

Returns:

  • (String, nil) 


62
 
# File 'lib/lithic/models/kyc_exempt.rb', line 62

optional :external_id, String

#first_name ⇒ String

The KYC Exempt user’s first name

Returns:

  • (String) 


23
 
# File 'lib/lithic/models/kyc_exempt.rb', line 23

required :first_name, String

#kyc_exemption_type ⇒ Symbol, Lithic::Models::KYCExempt::KYCExemptionType

Specifies the type of KYC Exempt user

Returns:



29
 
# File 'lib/lithic/models/kyc_exempt.rb', line 29

required :kyc_exemption_type, enum: -> { Lithic::KYCExempt::KYCExemptionType }

#last_name ⇒ String

The KYC Exempt user’s last name

Returns:

  • (String) 


35
 
# File 'lib/lithic/models/kyc_exempt.rb', line 35

required :last_name, String

#phone_number ⇒ String

The KYC Exempt user’s phone number, entered in E.164 format.

Returns:

  • (String) 


41
 
# File 'lib/lithic/models/kyc_exempt.rb', line 41

required :phone_number, String

#workflow ⇒ Symbol, Lithic::Models::KYCExempt::Workflow

Specifies the workflow type. This must be ‘KYC_EXEMPT’

Returns:



47
 
# File 'lib/lithic/models/kyc_exempt.rb', line 47

required :workflow, enum: -> { Lithic::KYCExempt::Workflow }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/kyc_exempt.rb', line 95