Response Definitions
Return Length
All return string types are a max of 128 bytes unless otherwise stated.
| NAME | TYPE | DESCRIPTION |
|---|---|---|
status |
integer | The status of the request. A response of 0 indicates success. Any non-0 response is an error indication. For more information on status codes, see the Error and Status Codes section. |
requestId |
string | The requestId from the request, reflected back for tracking purposes. |
trustScore |
integer | An integer value ranging from 0 - 1000 that denotes the real-time trustworthiness of a phone number. 1000 indicates perfect trust while 0 indicates a complete lack of trust. |
indicators |
array | An array of indicators provide additional context about the transaction. See TDS Indicators Reference Information for detailed reason codes. |
callInSession |
boolean | Returns true or false based on whether the phone number is currently in an active call. This feature is not turned on by default. Please contact your account representative to enable this field. |
riskLevel |
integer | Risk Level is an integer from -1 to 4 denoting the relative age and risk level of the SIM or tenure of the mobile number. -1 = The SIM date/time information is not available 0 = The SIM date/time is outside of an expected time frame or the date/time field is missing 1 = The SIM has swapped within the last 24 hours 2 = The SIM has swapped in a timeframe between 24 and 72 hours 3 = The SIM has swapped in a timeframe between 72 and 720 hours 4 = The SIM has not swapped within the last 720 hours |
simTimestamp |
string | The time stamp of the most recent SIM swap on the account. If there has been no recent SIM swaps, the date of account origination is returned. This field is returned in details only when available and is not guaranteed to be present. |
callDirection |
string | Returns MO (outgoing call) or MT (incoming call) when callInSession is true. This feature is not turned on by default. Please contact your account representative to enable this field. |
callDuration |
string | Returns the duration (in seconds) of the active call when callInSession is true. This feature is not turned on by default. Please contact your account representative to enable this field. |
phoneRisk |
boolean | This phone number was seen on a public website that lists shared phone numbers for free use. |
troubleshootingId |
string | Unique transaction identifier used to identify the results of the request. |
carrier |
string | The carrier related to the phone number. |
lineType |
string | Line type associated with the phone number. mobile landline fixedvoip voip service other |
countryCode |
string | Country of the MNO in ISO 3166-1 alpha-2 country code format (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) |