Intelligence - Get started

This page includes general requirements and service details for this product, as well as instructions on how to use all of its actions.

Looking for insights reason codes? Check out Intelligence - Insights reason code mappings.

Reference page

Submit a phone number to evaluate

General requirements

• Authentication: Basic (easiest to implement) or Digest
• Endpoint: https://rest-ww.telesign.com/v1/score
• 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

Understanding a risk recommendation for a phone number

Intelligence provides a risk recommendation that you can use in combination with other elements to decide whether to allow, flag, or block a phone number, or take any other measures such as additional verifications that you deem appropriate. risk.score is a measure of the transaction risk involved with conducting an online business transaction at the current time for the given phone number. The scale ranges from zero to 1000, with a higher value indicating a higher risk.

The other details related to risk that are returned with risk.score are:

• risk.level: The risk level is an assessment of the level of transaction risk involved with conducting business at the current time for the given phone number.
• risk.recommendation: The risk recommendation is advice on the general course of action to follow for handling this transaction (to either proceed with the transaction, to proceed with caution, or to not proceed at all).

Insights

Insights is an option available in Intelligence 2.0 that provides different details related to the risk presented by the phone number. See Intelligence - Insights reason code mappings for more detail about each available insight.

Risk recommendation scale

Use this scale below to interpret the risk recommendation provided to you when you make a request.

Actions

Request a transaction risk recommendation for a phone number

Reference Page: Submit a phone number to evaluate

Use this action to obtain a transaction risk recommendation for a specified phone number. The service also provides the data elements you would normally see returned by Telesign Phone ID.

The reference page includes full details for each request parameter and response property.

Try it

If you have been granted access and credentials for Intelligence, you can try a test request by using the Submit a phone number to evaluate endpoint. You can also get a code snippet for the request.

🚧

CAUTION:

Using your account credentials in the API Explorer to request a risk recommendation results in your account being charged for the transaction.

Examples

Example 1: Success

Request

POST /v1/score/15555551212 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic pPF9MAXw9ssP0rkk8sbWf18Fny5Vgqi4F1owcHADr8LXk8PMWIvWqeg419NNXmBtMkaTJi3U5IOhOrNOY1ZXdBv3pLZxn08Rah8mMTGv623wYqmmNRcI5adDVnYbm1ejt2E4JCiMmOFahwcNcy844cpz8dTEWMVo1XthlYf=
Host: rest-ww.telesign.com
account_lifecycle_event=create&request_risk_insights=true&originating_ip=203.0.113.45&[email protected]

Response (body only)

{
  "reference_id": "0123456789ABCDEF0123456789ABCDEF",
  "status": {
    "updated_on": "2024-02-01T00:33:34.860418Z",
    "code": 300,
    "description": "Transaction successfully completed"
  },
  "numbering": {
    "original": {
      "complete_phone_number": "15555551212",
      "country_code": "1",
      "phone_number": "5555551212"
    },
    "cleansing": {
      "call": {
        "country_code": "1",
        "phone_number": "5555551212",
        "cleansed_code": 105,
        "min_length": 10,
        "max_length": 10
      },
      "sms": {
        "country_code": "1",
        "phone_number": "5555551212",
        "cleansed_code": 105,
        "min_length": 10,
        "max_length": 10
      }
    }
  },
  "phone_type": {
    "code": "8",
    "description": "INVALID"
  },
  "location": {
    "city": "Countrywide",
    "state": null,
    "zip": null,
    "metro_code": null,
    "county": null,
    "country": {
      "name": "United Kingdom",
      "iso2": "GB",
      "iso3": "GBR"
    },
    "coordinates": {
      "latitude": null,
      "longitude": null
    },
    "time_zone": {
      "name": null,
      "utc_offset_min": "0",
      "utc_offset_max": "0"
    }
  },
  "carrier": {
    "name": "Telefonica UK Limited"
  },
  "risk": {
    "level": "high",
    "recommendation": "block",
    "score": 959
  },
  "risk_insights": {
    "status": 800,
    "category": [
      10002
    ],
    "a2p": [
      20001,
      20101,
      21002
    ],
    "p2p": [
      30201
    ],
    "number_type": [
      40005,
      40011
    ],
    "ip": [
      50001,
      50004
    ],
    "email": [
      60003,
      60006
    ]
  }
}

Example 2: Failure

If something goes wrong with your request, the response you get looks like the example below. The exact response properties you see will depend on the type of failure.

Request

POST /v1/score/15555551212 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic pPF9MAXw9ssP0rkk8sbWf18Fny5Vgqi4F1owcHADr8LXk8PMWIvWqeg419NNXmBtMkaTJi3U5IOhOrNOY1ZXdBv3pLZxn08Rah8mMTGv623wYqmmNRcI5adDVnYbm1ejt2E4JCiMmOFahwcNcy844cpz8dTEWMVo1XthlYf=
Host: rest-ww.telesign.com
account_lifecycle_event=&request_risk_insights=true&originating_ip=203.0.113.45&[email protected]

Response (body only)

{
  "reference_id": "0123456789ABCDEF0123456789ABCDEF",
  "status": {
    "code": 11003,
    "description": "Invalid value for parameter account_lifecycle_event.",
    "updated_on": "2024-03-28T23:05:48.398146Z"
  }
}