Phonenumber Lookup Object

This section outlines the Phonenumber Lookup object.

Phonenumber Lookup Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
country_code read only	string	The ISO 3166-1 alpha-3 code of the country.
details read only	object	The detail object contains cnam, lrn, and carrier data. Refer to the table below for more information.
e164_format read only	string	The DID in the E.164 format.
in_country_format read only	string	The DID in a national format.
international_format read only	string	The DID in an international format.
phonenumber read only	string	The phone number.
state read only	string	Geographic area codes of this DID (for the US DIDs only).

Phonenumber Lookup Detail Object

Attribute	Data Type	Description
carrier read only	object	The carrier information for the phone number. Refer to the carrier table for more information.
cnam read only	object	The cnam information for the phone number. Refer to the cnam table for more information.
lrn read only	string	The location routing number.

Phonenumber Lookup Detail Carrier Object

Attribute	Data Type	Description
mcc read only	integer	The mobile country code.
mnc read only	integer	The mobile network code.
name read only	string	The carrier name.
type read only	string	The type of the DID. Values accepted in this field are: landline, mobile, and unknown.

Phonenumber Lookup Detail Cnam Object

Attribute	Data Type	Description
name read only	string	The caller name.
type read only	string	The caller type.

Sample Phonenumber Lookup Object

{
    "country_code": "USA",
    "details": {
        "carrier": {
            "mcc": null,
            "mnc": null,
            "name": null,
            "type": null
        },
        "cnam": {
            "name": "",
            "type": null
        },
        "lrn": "6466531111"
    },
    "e164_format": "+15162065319",
    "in_country_format": "(516) 206-5319",
    "international_format": "+1 516-206-5319",
    "phonenumber": "15162065319",
    "state": "NY"
}