Response Definitions

Sandbox You are viewing Sandbox mode docs. Switch using the toggle on the dashboard.

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 Error and Status Codes.
ipMatch boolean Indicates whether the request originated from an IP address on the API key's whitelist. Returns false if the requesting IP is not whitelisted, in which case no other data fields are returned.

If no IP whitelist is configured on the API key, this always returns true.
customerReference string The customerReference from the request, reflected back for tracking purposes.
requestId string The TDS-generated unique identifier for this request.
signature string A unique signature for this request. Store it alongside the requestId — pass both to the Risk Recall endpoint to retrieve this result again later.
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.

0 - 330 = High Risk. There has been recent concerning activity associated with the phone number so the pending transaction should be denied.
331 - 699 = Medium Risk. Some recent activity that may be concerning the activity of the phone number. Any indicators returned from the Trust Score should be factored into the decision process.
700 - 1000 = Low Risk. All indicators of trust are present with the phone number and the transaction should be approved.
indicators array An array of indicators provide additional context about the transaction. See TDS Indicators Reference Information for detailed reason codes.
callDivert boolean Indicates whether the phone number has call forwarding (call divert) enabled. Derived from the CF indicator reason code.
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.
phoneRisk boolean The phone number exists on websites exposing text message history publicly, which bad actors use to bypass possession checks. Derived from the D1 indicator reason code.
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)
audit_url string A permanent URL linking to the immutable audit record for this check, including the policy snapshot that was active at the time of the request.
policy_version string The version of the Users Policy that was in effect at the time this check was performed.
policy_hash string A cryptographic hash of the policy document that was active at the time of the request. Can be used to verify the policy has not changed.
API Overview