Phone ID - Identity attributes: Porting Status

📘

NOTE:

To add this feature to your account, contact a Telesign expert. This feature is available for full-service accounts only.

The Porting Status identity attribute allows you to find out if a phone number was ported or not and what carrier currently has the number. The information you get in a response includes the current MCC (mobile country code) and the current MNC (mobile network code).

Example request and responses for Porting Status

Request

POST https://rest-ww.telesign.com/v1/phoneid/15555551212 HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Date: Thu, 08 Nov 2018 14:11:09 GMT
Content-Type: application/json 
{
    "addons": {
        "porting_status": {}
    }
}

Response body - success

{
  "porting_status": {
    "mcc_current": "310",
    "mnc_current": "01",
    "ported": true,
    "status": {
      "code": 2800,
      "description": "Request successfully completed"
    }
  }
}

Response body - timeout

{
    "porting_status": {
        "status": {
            "code": 2811,
            "description": "Request processing timeout.",
        }
    }
}

Response body - out of coverage

{
  "porting_status": {
    "status": {
      "code": 2803,
      "description": "Phone number out of porting_status identity attribute coverage."
    }
  }
}

📘

NOTE:

Out of coverage means the device is too far from a cellular antenna, in a restricted area that blocks signals, or it may be off.

Porting Status request parameters

ParameterTypeDescription
addonsobjectYou must have your Technical Account Manager enable this feature for use. This parameter allows you to receive information returned from your enabled identity attributes.
addons.porting_statusstringInclude this parameter to initiate use of the Porting Status identity attribute.

Porting Status response properties

PropertyTypeDescription
reference_idstringA 32-digit hex value used to identify the web service requests. The value is unique to each web service request and is randomly generated by Telesign.
phone_typestringOne of the phone type codes.
descriptionstringText describing the phone type.
porting_statusobject
porting_status.mcc_currentstringThe mobile country code (MCC) for the current carrier associated with the device. The MNC is used in conjunction with the MCC to uniquely identify a carrier.
porting_status.mnc_currentstringThe mobile network code (MNC) for the current carrier associated with the device. The MNC is used in conjunction with the MCC to uniquely identify a carrier.
porting_status.portedbooleanIndicates whether the number was ported or not.
porting_status.statusobject
porting_status.status.codestringA numeric code indicating the processing status of your request.
porting_status.status.descriptionstringText description of the status.