class TelesignEnterprise::VerifyClient

The Verify API delivers phone-based verification and two-factor authentication using a time-based, one-time passcode sent via SMS message, Voice call or Push Notification.

Public Class Methods

new(customer_id, api_key, rest_endpoint: 'https://rest-ww.telesign.com', timeout: nil) click to toggle source
Calls superclass method
# File lib/telesignenterprise/verify.rb, line 16
def initialize(customer_id,
               api_key,
               rest_endpoint: 'https://rest-ww.telesign.com',
               timeout: nil)

  super(customer_id,
        api_key,
        rest_endpoint: rest_endpoint,
        timeout: timeout)
end

Public Instance Methods

completion(reference_id, **params) click to toggle source

Notifies TeleSign that a verification was successfully delivered to the user in order to help improve the quality of message delivery routes.

See developer.telesign.com/docs/completion-service-for-verify-products for detailed API documentation.

# File lib/telesignenterprise/verify.rb, line 88
def completion(reference_id, **params)

  self.put(VERIFY_COMPLETION_RESOURCE % {:reference_id => reference_id},
           **params)
end
push(phone_number, ucid, **params) click to toggle source

The Push Verify web service allows you to provide on-device transaction authorization for your end users. It works by delivering authorization requests to your end users via push notification, and then by receiving their permission responses via their mobile device's wireless Internet connection.

See developer.telesign.com/docs/rest_api-verify-push for detailed API documentation.

# File lib/telesignenterprise/verify.rb, line 67
def push(phone_number, ucid, **params)

  self.post(VERIFY_PUSH_RESOURCE,
            phone_number: phone_number,
            ucid: ucid,
            **params)
end
smart(phone_number, ucid, **params) click to toggle source

The Smart Verify web service simplifies the process of verifying user identity by integrating several TeleSign web services into a single API call. This eliminates the need for you to make multiple calls to the TeleSign Verify resource.

See developer.telesign.com/docs/rest_api-smart-verify for detailed API documentation.

# File lib/telesignenterprise/verify.rb, line 54
def smart(phone_number, ucid, **params)

  self.post(VERIFY_SMART_RESOURCE,
            phone_number: phone_number,
            ucid: ucid,
            **params)
end
sms(phone_number, **params) click to toggle source

The SMS Verify API delivers phone-based verification and two-factor authentication using a time-based, one-time passcode sent over SMS.

See developer.telesign.com/docs/rest_api-verify-sms for detailed API documentation.

# File lib/telesignenterprise/verify.rb, line 31
def sms(phone_number, **params)

  self.post(VERIFY_SMS_RESOURCE,
            phone_number: phone_number,
            **params)
end
status(reference_id, **params) click to toggle source

Retrieves the verification result for any verify resource.

See developer.telesign.com/docs/rest_api-verify-transaction-callback for detailed API documentation.

# File lib/telesignenterprise/verify.rb, line 78
def status(reference_id, **params)

  self.get(VERIFY_STATUS_RESOURCE % {:reference_id => reference_id},
           **params)
end
voice(phone_number, **params) click to toggle source

The Voice Verify API delivers patented phone-based verification and two-factor authentication using a one-time passcode sent over voice message.

See developer.telesign.com/docs/rest_api-verify-call for detailed API documentation.

# File lib/telesignenterprise/verify.rb, line 42
def voice(phone_number, **params)

  self.post(VERIFY_VOICE_RESOURCE,
            phone_number: phone_number,
            **params)
end