Skip to main content

​
Success Response Attributes

These attributes are returned for success response:
NameTypeDescription
api_idstringUniquely identifies the request.
phone_numberstringThe phone number that was looked up in the API request in E.164 format.
countrydictThree key-value pairs that provide information regarding the country:
• name (string): The name of the country to which this number belongs.
• iso2 (string): The two-letter country code defined in ISO 3166-1.
• iso3 (string): The three-letter country code defined in ISO 3166-1.
formatdictFour key-value pairs that provide different number formats:
• e164 (string): Number in E.164 format. Example: “+12045551111”
• national (string): Number in national format. Example: “(204) 555-1111”
• international (string): Number in international format. Example: “+1 204-555-1111”
• rfc3966 (string): Number in RFC 3966 format. Example: “tel:+1-204-555-1111”
carrierdictContains five key-value pairs related to the carrier:
• mobile_country_code (string): Mobile country code (MCC); for fixed numbers, this is empty_string.
• mobile_network_code (string): Mobile network code (MNC); for fixed numbers, this is empty_string.
• name (string): Carrier name; if unknown, set as empty_string.
• type (string): Type of number: fixed, mobile, voip, toll-free, or unknown.
• ported (string): Indicates if the number is ported: yes, no, or unknown (only available for USA and Canada).
resource_uristringThe URI that can be used to look up the same phone number again.

​
Error Response Attributes

These attributes are returned for error responses:
NameTypeDescription
api_idstringUniquely identifies the request.
error_codeintegerIndicates an error and provides the error code.
messagestringProvides error information regarding the request — given only when there’s an error.
Note: Only possible numbers (for a given region, using length and prefix information) will return formatting results. For further information about error codes in error responses, refer to the Troubleshooting page.
{
    "api_id": "e4a25a0a-a19f-4ff6-b8b5-1841bea253f6",
    "phone_number": "+16172252821",
    "country": {
        "name": "United States",
        "iso2": "US",
        "iso3": "USA"
    },
    "format": {
        "e164": "+16172252821",
        "national": "(617) 225-2821",
        "international": "+1 617-225-2821",
        "rfc3966": "tel:+1-617-225-2821"
    },
    "carrier": {
        "mobile_country_code": "",
        "mobile_network_code": "",
        "name": "Verizon",
        "type": "fixed",
        "ported": "no"
    },
    "resource_uri": "/v1/Number/+16172252821?type=carrier"
}