Number Deactivation Add-on

The Number Deactivation add-on allows you to find out whether a phone number has been deactivated, when it was deactivated, and by which carrier the phone number was deactivated based on carriers’ phone number data and TeleSign’s proprietary analysis. This information is returned in addition to the standard PhoneID API information.

The Number Deactivation add-on allows you to get information from the Number Deactivation API without having to implement it separately. The information returned includes:

  • Carrier: The name of the carrier which deactivated the phone number most recently.
  • Last Deactivated Timestamp: When the phone number was last deactivated.
  • Tracking Since Timestamp: The date and time when the phone number started being tracked for number deactivation events.
  • Recycled: Whether the number has been recycled since the last verified date you provide. Only returned if you include the last_verified parameter in your request.

Examples

Example 1: Success

Request
application/json
POST https://rest-ww.telesign.com/v1/phoneid/15555551212 HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Date: Thu, 12 Oct 2017 14:11:09 GMT
Content-Type: application/json

{
    "addons": {
        "number_deactivation": {
        	"last_verified": "2018-04-05T00:00:00Z"
        }
    }
}
Response (body only)
application/json
{
  "number_deactivation": {
    "carrier_name": "Verizon",
    "last_deactivated": "2018-04-06T00:00:00Z",
    "status": {
      "code": 2800,
      "description": "Request successfully completed"
    },
    "tracking_since": "2014-10-06T00:00:00Z",
    "recycled_since_last_verification": "recycled"
  }
}

Example 2: Failure

Request
application/json
POST https://rest-ww.telesign.com/v1/phoneid/15555551213 HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Date: Thu, 12 Oct 2017 14:11:09 GMT
Content-Type: application/json

{
  "addons": {
    "number_deactivation": {
      "last_verified": "2018-04-05T00:00:00Z"
    }
  }
}
Response (body only)
application/json
{
  "number_deactivation": {
    "status": {
      "code": 2603,
      "description": "Phone number out of number_deactivation add-on coverage."
    }
  }
}

Schema

Number Deactivation Request Parameters
object
addons
object

You must have you Technical Account Manager enable this feature for use. The addons parameter allows you to receive information returned from Contact, Contact Plus, Contact Match, or Number Deactivation, depending on which add-ons you enable. You receive add-on information back along with standard PhoneID information.

Number Deactivation Response
object
reference_id
string

A 32-digit hex value used to identify the web service requests. The value is unique to each web service request, is randomly generated by TeleSign, and is returned in the response message immediately following the web service request.

phone_type
string

One of the phone type codes.

description
string

Text describing the phone type.

number_deactivation
object

You will only see this in your response if you used the number deactivation add-on.