Class: PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb,
sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs

Overview

See Also:

  • PreludeSDK::Resources::Verification::Phone::History#retrieve

Defined Under Namespace

Modules: BlockReason, DevicePlatform, PhoneNumberCondition, PhoneNumberCurrentCondition, SignalsHashStatus, Status Classes: Lifecycle, Signals

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(is_trusted_user:, device_id: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil) ⇒ Object

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

The anti-fraud signals you forwarded when creating the verification.

Parameters:

  • is_trusted_user (Boolean) —

    Whether you flagged this end user as trusted when creating the verification. Dec

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

    End-user device identifier you forwarded.

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

    TLS fingerprint you forwarded.

  • os_version (String) (defaults to: nil)
  • user_agent (String) (defaults to: nil) 



# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 182

Instance Attribute Details

#app_version ⇒ String?

Version of your application, when known.

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 58

optional :app_version, String

#block_reasons ⇒ Array<Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason>?

Why the anti-fraud system blocked the verification. Empty unless it did.

  • behavioral_pattern - The phone number past behavior during verification flows exhibits suspicious patterns.
  • device_attribute - The end-user device reported attributes associated with fraud or emulation.
  • fraud_database - The phone number appears in a fraud database.
  • location_discrepancy - The phone number region and the observed location disagree.
  • missing_signals - The verification expected Prelude SDK signals and none arrived.
  • network_fingerprint - The network fingerprint matches known fraudulent traffic.
  • poor_conversion_history - The phone number rarely completes the verifications it starts.
  • prefix_concentration - The phone number is part of a range known to be associated with suspicious activity patterns.
  • repeated_number - The phone number was used far more often than normal traffic would explain.
  • suspected_request_tampering - The SDK signals were altered or expired between collection and use.
  • suspicious_ip_address - The originating IP address is associated with suspicious activity.
  • temporary_phone_number - The phone number is known to be a temporary or disposable number.

Returns:



88
89
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 88

optional :block_reasons,
-> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason] }

#carrier ⇒ PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier?

The end user's mobile network.

Returns:



95
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 95

optional :carrier, -> { PreludeSDK::Verification::Phone::PhoneVerificationCarrier }

#correlation_id ⇒ String?

The correlation identifier you supplied when creating the verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


101
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 101

optional :correlation_id, String

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


18
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 18

required :created_at, Time

#device_model ⇒ String?

Model of the end-user device, when known.

Parameters:

  • (String)

Returns:

  • (String, nil) 


107
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 107

optional :device_model, String

#device_platform ⇒ Symbol, ...

Platform of the end-user device, when known.

Returns:



113
114
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 113

optional :device_platform,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform }

#expires_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


23
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 23

required :expires_at, Time

#id ⇒ String

The verification identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 13

required :id, String

#ip_address ⇒ String?

IP address the verification was created from.

Parameters:

  • (String)

Returns:

  • (String, nil) 


120
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 120

optional :ip_address, String

#ip_address_region ⇒ String?

ISO 3166-1 alpha-2 region of the caller's IP address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


126
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 126

optional :ip_address_region, String

#ip_distance_meters ⇒ Integer?

Distance between the phone number region and the IP location.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


132
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 132

optional :ip_distance_meters, Integer

#lifecycle ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle?

Chronological timeline of the verification: creation, message attempts with delivery events, code checks and signals reception. Omitted when Prelude holds no timeline for the verification.

Returns:



140
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 140

optional :lifecycle, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle }

#phone_number ⇒ String

The E.164 phone number the verification targeted.

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 29

required :phone_number, String

#phone_number_condition ⇒ Symbol, ...

Whether the phone number was allow-listed, block-listed, or sandboxed at verification time.

Returns:



147
148
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 147

optional :phone_number_condition,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition }

#phone_number_current_condition ⇒ Symbol, ...

Whether the phone number is currently allow-listed, block-listed, or sandboxed.

Returns:



154
155
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 154

optional :phone_number_current_condition,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition }

#phone_number_region ⇒ String?

ISO 3166-1 alpha-2 region of the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


161
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 161

optional :phone_number_region, String

#signals ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals?

The anti-fraud signals you forwarded when creating the verification.

Returns:



167
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 167

optional :signals, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals }

#signals_hash_status ⇒ Symbol, ...

Whether the SDK signals integrity check passed.

Returns:



173
174
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 173

optional :signals_hash_status,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus }

#status ⇒ Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status

The outcome of the verification.

  • converted - The end user submitted a valid code.
  • not_converted - The verification expired without a valid code.
  • pending_check - A code was delivered and Prelude is still waiting for a check.
  • sent - A code was sent and the verification window is still open.
  • challenged - The verification was restricted to non-SMS and non-voice channels.
  • suspected_fraud - The anti-fraud system blocked the verification.
  • in_blocklist - The phone number is on the configured block list.
  • invalid_line - The phone number is not a valid line type.
  • invalid_number - The phone number is not a valid number.
  • rate_limited - The verification was refused by a rate limit.
  • expired_signals - The SDK signals were collected too long before the request.
  • shadowed - The anti-fraud system flagged the verification without blocking it.

Parameters:

  • value (PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::status)

Returns:



52
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 52

required :status, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status }

#template_id ⇒ String?

The template used for this verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


180
 
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 180

optional :template_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 267

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


145
 
# File 'sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs', line 145

def to_hash: -> {