Class: WhopSDK::Models::VerificationCreateParams::Body::Individual

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/verification_create_params.rb,
sig/whop_sdk/models/verification_create_params.rbs

Defined Under Namespace

Modules: DocumentType, Kind Classes: Address

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(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) ⇒ Object

Parameters:

  • city (String) (defaults to: nil)
  • country (String) (defaults to: nil) —

    Two-letter ISO 3166-1 country code, for example US, DE, or GB.

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

    First line of the street address.

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

    Second line of the street address.

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

    Postal or ZIP code.

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

    State, province, or region code, for example CA.




# File 'lib/whop_sdk/models/verification_create_params.rb', line 150

Instance Attribute Details

#address ⇒ WhopSDK::Models::VerificationCreateParams::Body::Individual::Address?

Returns:



65
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 65

optional :address, -> { WhopSDK::VerificationCreateParams::Body::Individual::Address }

#business_name ⇒ String?

Legal business name for a sole proprietor or single-member LLC.

Parameters:

  • (String)

Returns:

  • (String, nil) 


71
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 71

optional :business_name, String

#business_structure ⇒ String?

Entity type for sole proprietors, such as single_member_llc. Supported values vary by country of incorporation — see Business structures.

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 79

optional :business_structure, String

#business_website ⇒ String?

Business website URL. Whop store pages are not accepted.

Parameters:

  • (String)

Returns:

  • (String, nil) 


85
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 85

optional :business_website, String

#country ⇒ String?

Two-letter ISO 3166-1 country code, for example US, DE, or GB.

Parameters:

  • (String)

Returns:

  • (String, nil) 


91
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 91

optional :country, String

#date_of_birth ⇒ String?

Formatted as YYYY-MM-DD.

Parameters:

  • (String)

Returns:

  • (String, nil) 


97
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 97

optional :date_of_birth, String

#document_type ⇒ Symbol, ...

Identity document being sent. Providing it (with documents) verifies from uploaded documents instead of a hosted session, and determines the expected documents keys: cards and licenses need front and back, passports only the photo page.

Returns:



106
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 106

optional :document_type, enum: -> { WhopSDK::VerificationCreateParams::Body::Individual::DocumentType }

#documents ⇒ Hash{Symbol=>String}?

Identity document files, keyed by slot (id_card_front, id_card_back, selfie, …) with each value the file's raw bytes base64-encoded. Providing them verifies the person from these documents instead of a hosted session — individual verifications only, and the request must also carry document_type, first_name, last_name, date_of_birth, country, phone, tax_identification_number, and an address with line1, city, state, and postal_code. JPEG, PNG, and PDF are accepted (selfies must be images), up to 5MB per file before encoding. Send the complete set — a missing or rejected file fails the whole request and nothing is submitted; review starts automatically once every document is accepted.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


121
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 121

optional :documents, WhopSDK::Internal::Type::HashOf[String]

#first_name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


126
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 126

optional :first_name, String

#kind ⇒ Symbol, ...

Verification type. Defaults to individual.

Returns:



132
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 132

optional :kind, enum: -> { WhopSDK::VerificationCreateParams::Body::Individual::Kind }

#last_name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


137
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 137

optional :last_name, String

#phone ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


142
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 142

optional :phone, String

#tax_identification_number ⇒ String?

SSN or ITIN. Tokenized in transit and never stored raw.

Parameters:

  • (String)

Returns:

  • (String, nil) 


148
 
# File 'lib/whop_sdk/models/verification_create_params.rb', line 148

optional :tax_identification_number, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/verification_create_params.rb', line 254

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


129
 
# File 'sig/whop_sdk/models/verification_create_params.rbs', line 129

def to_hash: -> {