post

/v1/score/{complete_phone_number}

Obtain a score for this phone number, as well as other relevant information.

Looking for the general requirements for this API? Go to Get Started.

General Requirements

Request Requirements

  • Endpoint: https://rest-ww.telesign.com/v1/score/{complete_phone_number}
  • Authentication: Basic (easiest to implement) or Digest
  • Encoding: Accepts only UTF-8 unicode characters as inputs.
  • MIME Type: application/x-www-form-urlencoded
  • Required Headers: Content-Type - application/x-www-form-urlencoded

Response Details

  • MIME Type: application/json

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
Allowed Values: create, sign-in, transact, update, delete
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 Architecture.

device_id
string

Your end user’s device ID. This value is case sensitive.

account_id
string

Your end user’s account ID. This value is case sensitive.

email_address
string

Your end user’s email address. This value is case sensitive.

request_risk_insights
string

Pass a "true" value to receive Score 2.0 results from the API, instead of Score 1.0 results. The additional response property risk_insights is also returned when including a "true" value here. Do not include this parameter unless you have the Score 2.0 feature enabled by our Customer Support Team, as it will cause an error. If you do have the Score 2.0 feature enabled, this parameter is required.

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 code property in the response object and use that, rather than the HTTP status code. Individual packages within the response may have their own status codes as well.

Status Code Associated Text String Description
300 Transaction successfully completed The system was able to obtain all of the requested data.
301 Transaction partially completed The system was able to obtain some of the data, 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.

1 validation
external_id
string or null

The customer-generated ID for this transaction that was provided in the request. If the external_id parameter was not included in the request, the value here is null.

1 validation
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
blocklisting
object

An object containing details about whether the number was blocked and who requested the block. To see this information, speak with our Customer Support Team to have blocklisting information enabled.

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

risk_insights
object

Contains reason code properties with additional info related to the risk score.
Insights Reason Code Mappings provides the meaning of these reason codes.
Only returned when the request_risk_insights parameter is passed as "true" 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