Class: Lithic::Models::KYC

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

Defined Under Namespace

Modules: Workflow Classes: Individual

Instance Attribute 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:, dob:, email:, first_name:, government_id:, last_name:, phone_number:) ⇒ Object

Some parameter documentations has been truncated, see Individual for more details.

Information on individual for whom the account is being opened and KYC is being run.

Parameters:

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

    Individual’s current address - PO boxes, UPS drops, and FedEx drops are not acce

  • dob (String) —

    Individual’s date of birth, as an RFC 3339 date.

  • email (String) —

    Individual’s email address.

  • first_name (String) —

    Individual’s first name, as it appears on government-issued identity documents.

  • government_id (String) —

    Government-issued identification number (required for identity verification and

  • last_name (String) —

    Individual’s last name, as it appears on government-issued identity documents.

  • phone_number (String) —

    Individual’s phone number, entered in E.164 format.




# File 'lib/lithic/models/kyc.rb', line 43

Instance Attribute Details

#external_id ⇒ String?

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

Returns:

  • (String, nil) 


32
 
# File 'lib/lithic/models/kyc.rb', line 32

optional :external_id, String

#individual ⇒ Lithic::Models::KYC::Individual

Information on individual for whom the account is being opened and KYC is being run.

Returns:



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

required :individual, -> { Lithic::KYC::Individual }

#kyc_passed_timestamp ⇒ String?

An RFC 3339 timestamp indicating when precomputed KYC was completed on the individual with a pass result.

This field is required only if workflow type is ‘KYC_BYO`.

Returns:

  • (String, nil) 


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

optional :kyc_passed_timestamp, String

#tos_timestamp ⇒ String

An RFC 3339 timestamp indicating when the account holder accepted the applicable legal agreements (e.g., cardholder terms) as agreed upon during API customer’s implementation with Lithic.

Returns:

  • (String) 


19
 
# File 'lib/lithic/models/kyc.rb', line 19

required :tos_timestamp, String

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

Specifies the type of KYC workflow to run.

Returns:



25
 
# File 'lib/lithic/models/kyc.rb', line 25

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