Get Live Status info

get

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

Use this action to get insights about a phone number such as whether it is active or disconnected, whether its associated device is reachable or unreachable, and its associated device's roaming status.

To add this product to your account, contact a Telesign expert. This product is available for full-service accounts only.

General requirements

Protocols: https
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

Frequency of same number requests

Sending too many request to the API for the same phone number within a short period of time may result in an error, even if data is available for that number. If you receive a -60001 error in the response after making consecutive requests for the same phone number, consider limiting your request rate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

complete_phone_number

string

required

The phone number you want to collect information about. Provide the entire phone number, including the country code, with no spaces or special characters.

Query Params

ucid

string

A string that specifies one of the use case codes.

Use Case	Description
ATCK	For use in a 2FA situation like updating an account, or trying to log in.
BACF	For creating an account on somebody's service in a situation where the service may be vulnerable to bulk attacks or individual fraudsters.
BACS	For creating an account on somebody's service in a situation where the service may be vulnerable to bulk attacks or individual spammers.
CHBK	For use in a situation such as someone trying to buy something expensive or unusual on your platform, and you want to verify that it is really them.
CLDR	Calendar Event
LEAD	For use in a situation where you require a person to enter their personal information in order to obtain information about something like a loan or realty or a school, and you want to check if the person is bogus or not.
OTHR	Other - if you have a situation not addressed by the other tags.
PWRT	For use in a situation where a password reset is required.
RESV	For use in a situation where you have end users making reservations and not showing up, and you want to be able to include some kind of phone verification in that loop.
RXPF	For use in situations where you are trying to prevent prescription fraud.
SHIP	For use in situations where you are sending a shipping notification.
THEF	For use in situations where you are trying to prevent an end user from deactivating or redirecting a phone number in order to take over someone else's identity.
TRVF	For use in situations where you are transferring money, and you want to check to see if it is approved by sending a text message or phone call to your end user. This is similar to CHBK, but is specifically for a money transaction.
UNKN	This is the same as OTHR.

Responses

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.

Error Code	Description
-10001	Not Allowed Host (indicates that the IP address you are connecting from is not authorized to access the service) -or- Unsupported product name
-40007	Rate limit exceeded

Error Codes	Description
-10009	Invalid source IP address
-20002	This product is not enabled for this customer ID
-20003	This feature is not enabled for this CustomerID
-30002	CustomerID Account Not Activated
-30003	CustomerID New Account Limit Reached
-40002	Not Authorized

Error Codes	Description
-40001	Status unavailable
-40004	Resource not found

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. Error codes are listed in the error parameter in the response.

405 Error CodesDescription-40005Method not allowed

500Invalid Transaction, transaction not attempted. Error codes are listed in the error parameter in the response.

503Service unavailable, try again. Error codes are listed in the error parameter in the response. Error CodeDescription-90001System unavailable; please try again later