Class: TelesignEnterprise::PhoneIdClient

Inherits:
Telesign::PhoneIdClient
  • Object
show all
Defined in:
lib/telesignenterprise/phoneid.rb

Overview

A set of APIs that deliver deep phone number data attributes that help optimize the end user verification process and evaluate risk.

TeleSign PhoneID provides a wide range of risk assessment indicators on the number to help confirm user identity, delivering real-time decision making throughout the number lifecycle and ensuring only legitimate users are creating accounts and accessing your applications.

Instance Method Summary collapse

Constructor Details

#initialize(customer_id, api_key, rest_endpoint: 'https://rest-ww.telesign.com', timeout: nil) ⇒ PhoneIdClient

Returns a new instance of PhoneIdClient.



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/telesignenterprise/phoneid.rb', line 19

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

Instance Method Details

#contact(phone_number, ucid, **params) ⇒ Object

The PhoneID Contact API delivers contact information related to the subscriber’s phone number to provide another set of indicators for established risk engines.

See developer.telesign.com/docs/rest_api-phoneid-contact for detailed API documentation.



55
56
57
58
59
60
 
# File 'lib/telesignenterprise/phoneid.rb', line 55

def contact(phone_number, ucid, **params)

  self.get(PHONEID_CONTACT_RESOURCE % {:phone_number => phone_number},
           ucid: ucid,
           **params)
end

#live(phone_number, ucid, **params) ⇒ Object

The PhoneID Live API delivers insights such as whether a phone is active or disconnected, a device is reachable or unreachable and its roaming status.

See developer.telesign.com/docs/rest_api-phoneid-live for detailed API documentation.



66
67
68
69
70
71
 
# File 'lib/telesignenterprise/phoneid.rb', line 66

def live(phone_number, ucid, **params)

  self.get(PHONEID_LIVE_RESOURCE % {:phone_number => phone_number},
           ucid: ucid,
           **params)
end

#number_deactivation(phone_number, ucid, **params) ⇒ Object

The PhoneID Number Deactivation API determines whether a phone number has been deactivated and when, based on carriers’ phone number data and TeleSign’s proprietary analysis.

See developer.telesign.com/docs/rest_api-phoneid-number-deactivation for detailed API documentation.



77
78
79
80
81
82
 
# File 'lib/telesignenterprise/phoneid.rb', line 77

def number_deactivation(phone_number, ucid, **params)

  self.get(PHONEID_NUMBER_DEACTIVATION_RESOURCE % {:phone_number => phone_number},
           ucid: ucid,
           **params)
end

#score(phone_number, ucid, **params) ⇒ Object

Score is an API that delivers reputation scoring based on phone number intelligence, traffic patterns, machine learning, and a global data consortium.

See developer.telesign.com/docs/rest_api-phoneid-score for detailed API documentation.



44
45
46
47
48
49
 
# File 'lib/telesignenterprise/phoneid.rb', line 44

def score(phone_number, ucid, **params)

  self.get(PHONEID_SCORE_RESOURCE % {:phone_number => phone_number},
           ucid: ucid,
           **params)
end

#standard(phone_number, **params) ⇒ Object

The PhoneID Standard API that provides phone type and telecom carrier information to identify which phone numbers can receive SMS messages and/or a potential fraud risk.

See developer.telesign.com/docs/rest_phoneid-standard for detailed API documentation.



34
35
36
37
38
 
# File 'lib/telesignenterprise/phoneid.rb', line 34

def standard(phone_number, **params)

  self.get(PHONEID_STANDARD_RESOURCE % {:phone_number => phone_number},
           **params)
end