Submit a phone number to evaluate

post deprecated

https://rest-ww.telesign.com/v1/score/{complete_phone_number}

📘
NOTE:
This page is for the on-prem version of Intelligence which is deprecated. Please complete your migration to the Intelligence Cloud API. This migration is mandatory.

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

General requirements

Authentication: Basic (easiest to implement) or Digest
Encoding: Accepts only UTF-8 unicode characters as inputs.
Accepts: application/x-www-form-urlencoded
Responds with: application/json
Required headers: Content-Type - application/x-www-form-urlencoded
Rate limit: Default rate limits by product

Path Params

complete_phone_number

string

required

Form Data

account_lifecycle_event

string

enum

required

The attempted action associated with this phone number for which you want to evaluate its risk. 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.

Allowed:

external_id

string

A customer-generated ID for this transaction. The response simply echoes the value provided for this parameter.

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 document 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.

Responses

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.

Status Code	Associated Text String
10032	Request blocked due to this number appearing on a TeleSign blocklist.
10033	Unverified phone_number requested for trial account.
11000	Invalid value for parameter phone_number
11001	Invalid country code for parameter phone_number
11002	Invalid value for parameter account_id
11003	Invalid value for parameter account_lifecycle_event
11005	Invalid value for parameter customer_id
11006	Invalid value for parameter device_id
11007	Invalid value for email_address
11010	Invalid value for parameter originating_ip
11011	Invalid value for parameter reference_id
12000	Missing required parameter phone_number
12003	Missing required parameter account_lifecycle_event

Status Code	Associated Text String
10008	Invalid signature
10009	Invalid value for parameter message
10010	Invalid value for parameter originating_ip
10011	Invalid value for parameter reference_id
10012	This feature is not enabled for this CustomerID
10013	Invalid Request. CustomerID Account Not Found
10014	Invalid source IP address
10015	Invalid customer ID

Status Code	Associated Text String
10019	Rate Limit Exceeded
10020	PhoneId Standard exceeded transaction hard cap. Request denied.

402Payment Required. 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 CodeAssociated Text String10030Insufficient funds in prepaid wallet

404Not Found, the server has not found anything matching the Request-URI. 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 CodeAssociated Text String10017Customer ID / Reference ID not found

500Invalid Transaction, transaction not attempted.

503Service Unavailable, system unavailable, try again.