Class: WhopSDK::Models::VerificationCreateResponse

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

Overview

See Also:

  • WhopSDK::Resources::Verifications#create

Defined Under Namespace

Modules: Kind, Status Classes: Address, RequestedInformation, RequiredDocument

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(category: nil, is_optional: nil, kind: nil, label: nil, multiple: nil) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::VerificationCreateResponse::RequestedInformation::RequestedFile for more details.

Parameters:

  • category (String, nil) (defaults to: nil) —

    File category to include with the uploaded file so Whop can route the document c

  • is_optional (Boolean) (defaults to: nil) —

    Whether this slot can be left empty.

  • kind (String, nil) (defaults to: nil) —

    Specific document type requested, such as Bank Statement. null for standard

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

    Label for this upload slot, such as Front of ID Document.

  • multiple (Boolean) (defaults to: nil) —

    Whether this slot accepts more than one file.




# File 'lib/whop_sdk/models/verification_create_response.rb', line 107

Instance Attribute Details

#address ⇒ WhopSDK::Models::VerificationCreateResponse::Address?

Address on the verification profile. null when no address is set.

Parameters:

Returns:



17
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 17

optional :address, -> { WhopSDK::Models::VerificationCreateResponse::Address }, nil?: true

#business_name ⇒ String?

Legal business name.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


23
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 23

optional :business_name, String, nil?: true

#business_structure ⇒ String?

Legal entity structure of the business, such as private_corporation or sole_proprietorship. Supported values vary by country of incorporation — see Business structures.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


31
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 31

optional :business_structure, String, nil?: true

#country ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


37
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 37

optional :country, String, nil?: true

#created_at ⇒ String?

When the verification profile was created, as an ISO 8601 timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 43

optional :created_at, String

#date_of_birth ⇒ String?

Formatted as YYYY-MM-DD.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


49
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 49

optional :date_of_birth, String, nil?: true

#first_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


54
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 54

optional :first_name, String, nil?: true

#id ⇒ String?

Verification profile ID, prefixed idpf_.

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 11

optional :id, String

#kind ⇒ Symbol, ...

Returns:



59
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 59

optional :kind, enum: -> { WhopSDK::Models::VerificationCreateResponse::Kind }

#last_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


64
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 64

optional :last_name, String, nil?: true

#requested_information ⇒ Array<WhopSDK::Models::VerificationCreateResponse::RequestedInformation>?

Fields or documents Whop still needs before review can continue. Submit answers with the Update Verification endpoint.

Returns:



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

optional :requested_information,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::VerificationCreateResponse::RequestedInformation] }

#required_documents ⇒ Array<WhopSDK::Models::VerificationCreateResponse::RequiredDocument>?

Documents for a document-upload verification and their progress. Present only on verifications created by sending documents. pending_upload documents were not accepted yet — send the full set again with another Create Verification call.

Returns:



81
82
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 81

optional :required_documents,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::VerificationCreateResponse::RequiredDocument] }

#session_url ⇒ String?

Hosted verification session URL for the user to complete identity checks. Expires 7 days after creation.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


89
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 89

optional :session_url, String, nil?: true

#status ⇒ Symbol, ...

Current verification state. not_started before any session has been created; pending while a session is in progress; action_required when items in requested_information need answers before review can continue; approved once verification succeeds; rejected if it fails. Call the Create Verification endpoint again to start a new session.

Returns:



99
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 99

optional :status, enum: -> { WhopSDK::Models::VerificationCreateResponse::Status }

#updated_at ⇒ String?

When the verification profile was last updated, as an ISO 8601 timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


105
 
# File 'lib/whop_sdk/models/verification_create_response.rb', line 105

optional :updated_at, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/verification_create_response.rb', line 201

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


93
 
# File 'sig/whop_sdk/models/verification_create_response.rbs', line 93

def to_hash: -> {