post

/score/{complete_phone_number}

The Score API is a REST API that delivers reputation scoring based on phone number intelligence, traffic patterns, machine learning, and a global data consortium. NOTE: If you try this API out using the API Explorer, you will be billed for the transaction as you normally would.

All requests submitted for the Score API:

  • Can be authenticated with Basic (easiest to implement) and Digest
  • Use https://rest-api.telesign.com/v1/score/<complete_phone_number> as the endpoint. The complete phone number includes the country code and has no special characters or spaces.
  • Accept only UTF-8 encoded unicode characters as inputs.
  • Use Content-Type application/x-www-form-urlencoded in request headers.

Request Parameters

1 Path Parameter

Request Body

Form data (application/x-www-form-urlencoded)
account_lifecycle_event
string

The account lifecycle event parameter allows you to send information about what stage an end user was in when you retrieved information about their phone number. Acceptable values for this parameter are -

  • create - For the creation of a new account.
  • sign-in - For when an end user signs in to their account.
  • transact - For when an end user completes a transaction within their account.
  • update - For when an update is performed, such as an update of account information or similar.
  • delete - For when an account is deleted.
required
originating_ip
string

Your end user’s IP address (do not send your own Ip address). IPv4 and IPv6 are supported. For IPv4, the value must be in the format defined by the Internet Engineering Task Force (IETF) in the Internet-Draft doucment titled Internet Protocol. For IPv6, the value must be in the format defined by the IETF in the Internet-Draft document titled IP Version 6 Addressing Arcitecture.

device_id
string

Your end user’s device ID. This value is case sensitive, a string, must be greated with Unicode characters, and encoded as UTF-8.

account_id
string

Your end user’s account ID. This value is case sensitive, a string, must be created with Unicode characters, and encoded as UTF-8.

email_address
string

Your end user’s email address. This value is case sensitive, a string, must be created with Unicode characters, and encoded as UTF-8.

Responses

Your request was fulfilled and resulted in a new resource being created. If you want to code against a response, you should retrieve the status or error code and use that rather than the HTTP status response.

Status Code Associated Text String Description
300 Transaction successfully completed The system was able to obtain all of the requested data for PhoneID.
301 Transaction partially completed The system was able to obtain some of the data for PhoneID, but not all of it.
Schema
object
reference_id
string

A 32-digit hex value used to identify the web service request. The value is unique to each web service request, is randomly-generated by TeleSign, and is returned in the response message immediately following the web service request.

status
object

An object containing details about the request status.

numbering
object

An object containing details about the numbering attributes of the specified phone number.

phone_type
object
carrier
object

An object containing information about the company that provides telecommunications servoces for the phone number.

risk
object

An object that describes the risk score for the phone number specified in the request

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
complete_phone_number
$$.env
1 variable not set
host