Class: PreludeSDK::Resources::Verification

Inherits:

Object

• Object
• PreludeSDK::Resources::Verification

Defined in:

lib/prelude_sdk/resources/verification.rb,
sig/prelude_sdk/resources/verification.rbs

Overview

Verify phone numbers.

Instance Method Summary

• #check(code:, target:, psd2: nil, request_options: {}) ⇒ PreludeSDK::Models::VerificationCheckResponse

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

• #create(target:, dispatch_id: nil, metadata: nil, options: nil, signals: nil, request_options: {}) ⇒ PreludeSDK::Models::VerificationCreateResponse

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

• #initialize(client:) ⇒ Verification constructor private

  A new instance of Verification.

Constructor Details

#initialize(client:) ⇒ Verification

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Verification.

Parameters:

• client (PreludeSDK::Client)
• client: (PreludeSDK::Client)

# File 'lib/prelude_sdk/resources/verification.rb', line 74

def initialize(client:)
  @client = client
end

Instance Method Details

#check(code:, target:, psd2: nil, request_options: {}) ⇒ PreludeSDK::Models::VerificationCheckResponse

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

Check the validity of a verification code.

Parameters:

• code (String) —

  The OTP code to validate.

• target (PreludeSDK::Models::VerificationCheckParams::Target) —

  The verification target. Either a phone number or an email address. To use the e

• psd2 (PreludeSDK::Models::VerificationCheckParams::Psd2) —

  Required when checking a code issued under the prelude:psd2 template. The subm

• request_options (PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (PreludeSDK::Models::VerificationCheckResponse)

See Also:

• Models::VerificationCheckParams

# File 'lib/prelude_sdk/resources/verification.rb', line 60

def check(params)
  parsed, options = PreludeSDK::VerificationCheckParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v2/verification/check",
    body: parsed,
    model: PreludeSDK::Models::VerificationCheckResponse,
    options: options
  )
end

#create(target:, dispatch_id: nil, metadata: nil, options: nil, signals: nil, request_options: {}) ⇒ PreludeSDK::Models::VerificationCreateResponse

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

Create a new verification for a specific phone number. If another non-expired verification exists (the request is performed within the verification window), this endpoint will perform a retry instead.

Parameters:

• target (PreludeSDK::Models::VerificationCreateParams::Target) —

  The verification target. Either a phone number or an email address. To use the e

• dispatch_id (String) —

  The identifier of the dispatch that came from the front-end SDK.

• metadata (PreludeSDK::Models::VerificationCreateParams::Metadata) —

  The metadata for this verification. This object will be returned with every resp

• options (PreludeSDK::Models::VerificationCreateParams::Options) —

  Verification options

• signals (PreludeSDK::Models::VerificationCreateParams::Signals) —

  The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2

• request_options (PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (PreludeSDK::Models::VerificationCreateResponse)

See Also:

• Models::VerificationCreateParams

# File 'lib/prelude_sdk/resources/verification.rb', line 31

def create(params)
  parsed, options = PreludeSDK::VerificationCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v2/verification",
    body: parsed,
    model: PreludeSDK::Models::VerificationCreateResponse,
    options: options
  )
end