{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telesign/main/json-schema/telesign-get-phone-id-live-response-schema.json",
  "title": "getPhoneIdLiveResponse",
  "x-generated": "2026-10-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telesign-detect-api-openapi.yml#/components/schemas/getPhoneIdLiveResponse",
  "type": "object",
  "properties": {
    "reference_id": {
      "type": "string",
      "description": "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. "
    },
    "sub_resource": {
      "type": "string",
      "description": "The subresource in the URL accessed by this request.\n"
    },
    "errors": {
      "type": "array",
      "description": "An array of objects, one for each error that resulted from the request.",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "A one to five-digit error code (possibly negative) that indicates the type of error that occurred."
          },
          "description": {
            "type": "string",
            "description": "A text description of this error."
          }
        }
      }
    },
    "phone_type": {
      "type": "object",
      "description": "Contains properties with details about the phone type. ",
      "properties": {
        "code": {
          "type": "string",
          "description": "One of the [phone type codes](/enterprise/docs/codes-languages-and-time-zones#phone-type-codes)."
        },
        "description": {
          "type": "string",
          "description": "Text describing the phone type. "
        }
      }
    },
    "status": {
      "type": "object",
      "description": "Contains properties with details about the request status. ",
      "properties": {
        "code": {
          "type": "integer",
          "description": "A numeric code indicating the processing status of this request."
        },
        "description": {
          "type": "string",
          "description": "Text describing the transaction status."
        },
        "updated_on": {
          "type": "string",
          "description": "An [RFC 3339](http://www.ietf.org/rfc/rfc3339.txt) timestamp indicating when the transaction status was updated."
        }
      }
    },
    "numbering": {
      "type": "object",
      "description": "Contains properties related to the numbering attributes of the specified phone number. ",
      "properties": {
        "original": {
          "type": "object",
          "description": "Contains details of the phone number specified in the original request.",
          "properties": {
            "phone_number": {
              "type": "string",
              "description": "The base phone number. This is the phone number without the country dialing code."
            },
            "complete_phone_number": {
              "type": "string",
              "description": "The base phone number prefixed with the [country dialing code](/enterprise/docs/codes-languages-and-time-zones#country-codes-and-dialing-codes)."
            },
            "country_code": {
              "type": "string",
              "description": "A 1, 2, or 3-digit number representing the [country dialing code](/enterprise/docs/codes-languages-and-time-zones#country-codes-and-dialing-codes). For example, the country dialing code for both the U.S.A. and Canada is 1, and the country dialing code for the United Kingdom is 44."
            }
          }
        },
        "cleansing": {
          "type": "object",
          "description": "Contains details about how the phone number was cleansed. Phone cleansing corrects common formatting issues in submitted phone numbers.",
          "properties": {
            "call": {
              "type": "object",
              "description": "Contains cleansing details about the phone number if it is enabled for receiving voice calls. ",
              "properties": {
                "cleansed_code": {
                  "type": "integer",
                  "description": "One of the [phone number cleansing codes](/enterprise/docs/codes-languages-and-time-zones#phone-number-cleansing-codes) describing the cleansing operation TeleSign performed on the phose number. The default value is 100 (no changes were made to the phone number)."
                },
                "country_code": {
                  "type": "string",
                  "description": "A 1, 2, or 3-digit number representing the [country dialing code](/enterprise/docs/codes-languages-and-time-zones#phone-number-cleansing-codes). For example, the country dialing code for both the U.S.A. and Canada is 1, and the country dialing code for United Kingdom is 44."
                },
                "max_length": {
                  "type": "integer",
                  "description": "The maximum number of digits allowed for phone numbers with this particular country dialing code."
                },
                "min_length": {
                  "type": "integer",
                  "description": "The minimum number of digits allowed for phone numbers with this particular country dialing code."
                },
                "phone_number": {
                  "type": "string",
                  "description": "The base phone number. This is simply the phone number without the [country dialing code](/enterprise/docs/codes-languages-and-time-zones#phone-number-cleansing-codes)."
                }
              }
            },
            "sms": {
              "type": "object",
              "description": "Contains cleansing details about a phone number enabled for receiving text messages.",
              "properties": {
                "cleansed_code": {
                  "type": "integer",
                  "description": "One of the [phone number cleansing codes](/enterprise/docs/codes-languages-and-time-zones#phone-number-cleansing-codes) describing the cleansing operation TeleSign performed on the phose number. The default value is 100 (no changes were made to the phone number)."
                },
                "country_code": {
                  "type": "string",
                  "description": "A 1, 2, or 3-digit number representing the [country dialing code](/enterprise/docs/codes-languages-and-time-zones#phone-number-cleansing-codes). For example, the country dialing code for both the U.S.A. and Canada is 1, and the country dialing code for United Kingdom is 44."
                },
                "max_length": {
                  "type": "integer",
                  "description": "The maximum number of digits allowed for phone numbers with this particular country dialing code."
                },
                "min_length": {
                  "type": "integer",
                  "description": "The minimum number of digits allowed for phone numbers with this particular country dialing code."
                },
                "phone_number": {
                  "type": "string",
                  "description": "The base phone number. This is simply the phone number without the [country dialing code](/enterprise/docs/codes-languages-and-time-zones#phone-number-cleansing-codes)."
                }
              }
            }
          }
        }
      }
    },
    "location": {
      "type": "object",
      "description": "Contains geographical location information associated with the rate center of the phone number when the device was activated. Null is returned when data for a field isn't available for a specific market or country.",
      "properties": {
        "city": {
          "type": "string",
          "description": "The city associated with the rate center of the phone number when the device was activated."
        },
        "county": {
          "type": "string",
          "description": "The county (or parish) associated with the rate center of the phone number when the device was activated (U.S. only)."
        },
        "state": {
          "type": "string",
          "description": "The two-letter [state abbreviation code](http://pe.usps.com/text/pub28/28apb.htm) of the state (province, district, or territory) associated with the rate center of the phone number when the device was activated (North America only)."
        },
        "zip": {
          "type": "string",
          "description": "The five-digit United States Postal Service [ZIP Code](https://www.usps.com/nationalpremieraccounts/findzipcodes.htm) associated with the rate center of the phone number when the device was activated (U.S. only)."
        },
        "country": {
          "type": "object",
          "description": "Contains properties related to the country associated with the rate center of the phone number when the device was activated.",
          "properties": {
            "iso2": {
              "type": "string",
              "description": "The ISO 3166-1 2-letter [country dialing code](/enterprise/docs/codes-languages-and-time-zones#country-codes-and-dialing-codes) associated with the rate center of the phone number when the device was activated."
            },
            "iso3": {
              "type": "string",
              "description": "The ISO 3166-1 3-letter country code associated with the rate center of the phone number when the device was activated."
            },
            "name": {
              "type": "string",
              "description": "The [country name](/enterprise/docs/codes-languages-and-time-zones#country-codes-and-dialing-codes) associated with the rate center of the phone number when the device was activated."
            }
          }
        },
        "time_zone": {
          "type": "object",
          "description": "Contains properties related to the time zone associated with the rate center of the phone number when the device was activated. For maximum and minimum UTC offsets, they are specified in units of hours, and range from -12 to +14. For positive numbers, the plus sign (+) may not be returned. Additional offsets due to Daylight Savings Time or Summer Time are not considered. For example, Russia, which spans 11 time zones, has a minimum UTC offset of +2, and a maximum of +12.",
          "properties": {
            "name": {
              "type": "string",
              "description": "The time zone associated with the rate center of the phone number when the device was activated (U.S. only)."
            },
            "utc_offset_max": {
              "type": "string",
              "description": "For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the rate center of the phone number when the device was activated. For U.S. phone numbers, this parameter returns the same result as utc_offset_min."
            },
            "utc_offset_min": {
              "type": "string",
              "description": "For international phone numbers, this parameter returns the minimum UTC offset for the country associated with the rate center of the phone number when the device was activated. For U.S. phone numbers, this parameter returns the UTC offset associated with the rate center of the phone number when the device was activated. "
            }
          }
        },
        "coordinates": {
          "type": "object",
          "description": "Contains details about the geographical coordinates of the location where the phone number is registered.",
          "properties": {
            "latitude": {
              "type": "string",
              "description": "Latitude specifies the North-South position of a point on the Earth’s surface. It is an angular measurement that ranges from 0° at the Equator, to 90° at the North Pole (and -90° at the South Pole). It is returned here as a value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places."
            },
            "longitude": {
              "type": "string",
              "description": "Longitude specifies the East-West position of a point on the Earth’s surface. It is an angle measured East or West from the [prime meridian](https://en.wikipedia.org/wiki/Prime_meridian) —ranging from 0° at the prime meridian, to +180° Eastward and -180° Westward. It is returned here as a value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places."
            }
          }
        },
        "metro_code": {
          "type": "string",
          "description": "A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) code for the location associated with the rate center of the phone number when the device was activated (U.S. only). PMSA Codes are governed by the [US Census Bureau](http://www.census.gov/). This information is useful for large metropolitan areas that comprise several smaller cities. For example, the PMSA for Long Beach, California is Los Angeles County, which gives Long Beach the PMSA Code 4480."
        }
      }
    },
    "carrier": {
      "type": "object",
      "description": "Contains information about the company that provides telecommunications services for the phone number.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the carrier associated with this number."
        }
      }
    },
    "live": {
      "type": "object",
      "description": "Contains details about a subscriber and subscriber's device. ",
      "properties": {
        "subscriber_status": {
          "type": "string",
          "description": "The current status of the subscriber’s phone number.\n\n| Value | Description |\n|-------|-------------|\n| ACTIVE | The phone number is in service. |\n| DISCONNECTED | The phone number is not in service. |"
        },
        "device_status": {
          "type": "string",
          "description": "The current status of the device associated with this number.\n\n| Value | Description |\n|-------|-------------|\n| REACHABLE | The device is on-line, and is ready to initiate/receive calls. Note that subscriber_status=ACTIVE. |\n| UNAVAILABLE | The device status is not available for this phone number. |\n| UNREACHABLE | The device is either turned off, or it is out of the coverage area. |"
        },
        "roaming": {
          "type": "string",
          "description": "Whether the mobile device is currently roaming outside of the contracted service coverage area.\n\n| Value | Description |\n|-------|-------------|\n| NO | The mobile device is not currently roaming. |\n| UNAVAILABLE | The service is unable to make a determination at this time. |\n| YES | The mobile device is currently roaming. |"
        },
        "roaming_country": {
          "type": [
            "string",
            "null"
          ],
          "description": "The country in which the mobile device is roaming.\n\n| Value | Description |\n|-------|-------------|\n| A string naming the country | The name of the country (in mixed-case). |\n| null | The service is unable to make a determination at this time."
        },
        "roaming_country_iso2": {
          "type": [
            "string",
            "null"
          ],
          "description": "A two-character abbreviation for the country in which the mobile device is roaming."
        }
      }
    }
  }
}