Get Live Status info

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.

Path Params
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
string

A string that specifies one of the use case codes.

Use CaseDescription
ATCKFor use in a 2FA situation like updating an account, or trying to log in.
BACFFor creating an account on somebody's service in a situation where the service may be vulnerable to bulk attacks or individual fraudsters.
BACSFor creating an account on somebody's service in a situation where the service may be vulnerable to bulk attacks or individual spammers.
CHBKFor 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.
CLDRCalendar Event
LEADFor 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.
OTHROther - if you have a situation not addressed by the other tags.
PWRTFor use in a situation where a password reset is required.
RESVFor 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.
RXPFFor use in situations where you are trying to prevent prescription fraud.
SHIPFor use in situations where you are sending a shipping notification.
THEFFor 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.
TRVFFor 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.
UNKNThis is the same as OTHR.
Responses

error parameter in the response.

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

error parameter in the response.

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

error parameter in the response.

error parameter in the response.

Error CodesDescription
-40001Status unavailable
-40004Resource not found

error parameter in the response.

Error CodeDescription
-40008[Product method] exceed transaction hard cap; Request denied

error parameter in the response.

error parameter in the response.

Error CodeDescription
-90001System unavailable; please try again later

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json