> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peopledatalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Output Response - IP Enrichment API
## Response Data Structure
Here is an example response from the IP Enrichment API:
```json
{
"status": 200,
"data": {
"ip": {
"address": "72.212.42.169",
"metadata": {
"version": 4,
"mobile": false,
"hosting": false,
"proxy": false,
"tor": false,
"vpn": false,
"relay": false,
"service": null,
"asn_domain": null
},
"location": {
"name": "phoenix, arizona, united states",
"locality": "phoenix",
"region": "arizona",
"metro": "phoenix, arizona",
"country": "united states",
"continent": "north america",
"postal_code": "85001",
"geo": "33.44838,-112.07404",
"timezone": "america/phoenix"
}
},
"company": {
"confidence": "very high",
"id": "tnHcNHbCv8MKeLh92946LAkX6PKg",
"website": "peopledatalabs.com",
"name": "people data labs",
"display_name": "People Data Labs",
"location": {
"name": "san francisco, california, united states",
"locality": "san francisco",
"region": "california",
"metro": "san francisco, california",
"country": "united states",
"continent": "north america",
"street_address": "455 market street",
"address_line_2": "suite 1670",
"postal_code": "94105",
"geo": "37.77,-122.41"
},
"size": "11-50",
"industry": "computer software",
"inferred_revenue": "$25m-$50m",
"employee_count": 129,
"tags": [
"artificial intelligence",
"data and analytics",
"machine learning",
"analytics",
"database",
"software",
"developer apis",
"data",
"people data",
"data science"
]
},
"person": {
"confidence": "very high",
"job_title_sub_role": "product",
"job_title_role": "operations",
"job_title_levels": [
"cxo"
]
},
"dataset_version": "1.1.0.2024w19"
}
}
```
## Response Fields
### `status`
| Type | Description |
| :-------- | :----------------------------------- |
| `Integer` | The [API response code](https://docs.peopledatalabs.com/docs/errors). |
### `data`
| Type | Description |
| :------- | :--------------------------------------------------------------------------------------------------------------- |
| `Object` | The information about the IP address from the [`ip` input parameter](https://docs.peopledatalabs.com/docs/input-parameters-ip-enrichment-api#ip). |
The `data` object contains the entire record for the IP address that matches the Enrichment API request. Any fields within the `data` object that we do not have data for will have a `null` value.
### `data.ip`
| Type | Description |
| :------- | :------------------------------------- |
| `Object` | Information related to the IP address. |
### `data.ip.address`
| Type | Description |
| :------- | :---------------------- |
| `String` | The matched IP address. |
The IP that matches the [API input `ip`](https://docs.peopledatalabs.com/docs/input-parameters-ip-enrichment-api#ip) after it's passed through our validity checks.
### `data.ip.metadata`
| Type | Description |
| :------- | :-------------------------------------------------------------------------------------------------------------------- |
| `Object` | Premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services. |
The `metadata` object is a **premium add-on** available for an additional price. It contains the following fields:
| Field | Type | Description |
| :----------- | :----------------- | :------------------------------------------------- |
| `version` | `Integer (4 or 6)` | The type of IP Address (IPv4 or IPv6). |
| `mobile` | `Boolean` | If the IP is a known mobile address. |
| `hosting` | `Boolean` | If the IP is a known hosting address. |
| `proxy` | `Boolean` | If the IP is a known proxy address. |
| `tor` | `Boolean` | If the IP is a known Tor address. |
| `vpn` | `Boolean` | If the IP is a known VPN address. |
| `relay` | `Boolean` | If the IP is a known relay address. |
| `service` | `String` | If known, the name of the service for the address. |
| `asn_domain` | `String` | The domain associated with the ASN block. |
### `data.ip.location`
| Type | Description |
| :------- | :------------------------------------------- |
| `Object` | The location associated with the IP address. |
The `location` object will contain some of our [common location fields](https://docs.peopledatalabs.com/docs/data-types#common-location-fields) as well as the location timezone:
| Field | Data Type | Description |
| :------------ | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | `String` | Our cleaned values for locations in the format `locality, region, country`. |
| `locality` | `String` | |
| `region` | `String` | |
| `metro` | `Enum (String)` | **US ONLY.** These are generated based on the census-designated MSAs and maps. Will be one of our [Canonical Metros](https://docs.peopledatalabs.com/docs/location-metros). |
| `country` | `Enum (String)` | Standardized format for country. Will be one of our [Canonical Countries](https://docs.peopledatalabs.com/docs/location-countries). |
| `continent` | `Enum (String)` | Standardized format for continent. Will be one of our [Canonical Continents](https://docs.peopledatalabs.com/docs/location-continents). |
| `postal_code` | `String` | |
| `geo` | `String` | City-center geo code of a locality, in the format `latitude, longitude`. |
| `timezone` | `Enum (String)` | The timezone the address is in. Will be lowercase and one of the Global Time Zone values found [here](https://docs.trifacta.com/display/DP/Supported+Time+Zone+Values). |
### `data.company`
| Type | Description |
| :------- | :----------------------------------------------------------------- |
| `Object` | Information related to the company associated with the IP address. |
Many of the fields in the `data.company` object come directly from our [Company Schema](https://docs.peopledatalabs.com/docs/company-schema).
### `data.company.confidence`
| Type | Description |
| :-------------- | :------------------------------------------------------------------------------ |
| `Enum (String)` | How confident we are that the returned company is associated with requested IP. |
Will be one of the following options: `very high`, `high`, `moderate`, `low`, `very low`.
Our company matches are created with observed data along with registered ASN blocks. For matches we make with observed data, the confidence value is our scoring for how much and how often we have seen a company associated with an IP address.
### `data.company.id`
| Type | Description |
| :------- | :------------------------------------------------------------------------------------------------------------------ |
| `String` | The [PDL ID](https://docs.peopledatalabs.com/docs/company-schema#id) of the company associated with the IP address. |
See [`company.id`](https://docs.peopledatalabs.com/docs/company-schema#id) for more information about how we handle company IDs.
### `data.company.website`
| Type | Description |
| :------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| `String` | The [primary website](https://docs.peopledatalabs.com/docs/company-schema#website) of the company associated with the IP address. |
See [`company.website`](https://docs.peopledatalabs.com/docs/company-schema#website) for more information about how we handle company websites.
### `data.company.name`
| Type | Description |
| :------- | :------------------------------------------------------------------------------------------------------------------ |
| `String` | The [name](https://docs.peopledatalabs.com/docs/company-schema#name) of the company associated with the IP address. |
See [`company.name`](https://docs.peopledatalabs.com/docs/company-schema#name) for more information about how we handle company names.
### `data.company.display_name`
| Type | Description |
| :------- | :----------------------------------------------------------------------------------------------------------------------------------- |
| `String` | The [display\_name](https://docs.peopledatalabs.com/docs/company-schema#display_name) of the company associated with the IP address. |
See [`company.display_name`](https://docs.peopledatalabs.com/docs/company-schema#display_name) for more information about how we handle company names.
### `data.company.location`
| Type | Description |
| :------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
| `Object` | The [location](https://docs.peopledatalabs.com/docs/company-schema#location) of the company's primary HQ associated with the IP address. |
The `location` object will contain our [common location fields](https://docs.peopledatalabs.com/docs/data-types#common-location-fields):
| Field | Data Type | Description |
| :--------------- | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | `String` | Our cleaned values for locations in the format `locality, region, country`. |
| `locality` | `String` | |
| `region` | `String` | |
| `metro` | `Enum (String)` | **US ONLY.** These are generated based on the census-designated MSAs and maps. Will be one of our [Canonical Metros](https://docs.peopledatalabs.com/docs/location-metros). |
| `country` | `Enum (String)` | Standardized format for country. Will be one of our [Canonical Countries](https://docs.peopledatalabs.com/docs/location-countries). |
| `continent` | `Enum (String)` | Standardized format for continent. Will be one of our [Canonical Continents](https://docs.peopledatalabs.com/docs/location-continents). |
| `street_address` | `String` | |
| `address_line_2` | `String` | |
| `postal_code` | `String` | |
| `geo` | `String` | City-center geo code of a locality, in the format `latitude, longitude`. |
### `data.company.size`
| Type | Description |
| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| `Enum (String)` | The self-reported [size range](https://docs.peopledatalabs.com/docs/company-sizes) of the company associated with the IP address. |
See [`company.size`](https://docs.peopledatalabs.com/docs/company-schema#size) for more information about how we handle company size ranges.
### `data.company.industry`
| Type | Description |
| :-------------- | :--------------------------------------------------------------------------------------------------------------------------- |
| `Enum (String)` | The self-reported [industry](https://docs.peopledatalabs.com/docs/industries) of the company associated with the IP address. |
See [`company.industry`](https://docs.peopledatalabs.com/docs/company-schema#industry) for more information about how we handle company industries.
### `data.company.inferred_revenue`
| Type | Description |
| :-------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Enum (String)` | The [estimated annual revenue](https://docs.peopledatalabs.com/docs/inferred-revenue-ranges) (in USD) of the company associated with the IP address. |
See [`company.inferred_revenue`](https://docs.peopledatalabs.com/docs/company-schema#inferred_revenue) for more information about how we handle company revenues.
### `data.company.employee_count`
| Type | Description |
| :-------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Integer (> 0)` | The current [number of employees](https://docs.peopledatalabs.com/docs/company-schema#employee_count) working at the company associated with the IP address. |
See [`company.employee_count`](https://docs.peopledatalabs.com/docs/company-schema#employee_count) for more information about how we handle company employee counts.
### `data.company.tags`
| Type | Description |
| :--------------- | :--------------------------------------------------------------------------------------------------------------------------- |
| `Array [String]` | [Tags](https://docs.peopledatalabs.com/docs/company-schema#tags) associated with the company associated with the IP address. |
See [`company.tags`](https://docs.peopledatalabs.com/docs/company-schema#tags) for more information about how we handle company tags.
### `data.person`
| Type | Description |
| :------- | :--------------------------------------------------------------- |
| `Object` | Information related to the person associated with the IP address |
### `data.person.confidence`
| Type | Description |
| :-------------- | :----------------------------------------------------------------------------- |
| `Enum (String)` | How confident we are that the returned person is associated with requested IP. |
Will be one of the following options: `very high`, `high`, `moderate`, `low`, `very low`.
### `data.person.job_title_sub_role`
| Type | Description |
| :-------------- | :----------------------------------------------------- |
| `Enum (String)` | The derived subrole of the person's current job title. |
The value will be one of our [Canonical Job Sub Roles](https://docs.peopledatalabs.com/docs/job-title-subroles). Each subrole maps to a role. See `` for a complete mapping list.
### `data.person.job_title_role`
| Type | Description |
| :-------------- | :-------------------------------------------------- |
| `Enum (String)` | The derived role of the person's current job title. |
The value will be one of our [Canonical Job Roles](https://docs.peopledatalabs.com/docs/job-title-roles).
### `data.person.job_title_levels`
| Type | Description |
| :---------------------- | :----------------------------------------------------- |
| `Array [Enum (String)]` | The derived level(s) of the person's current job title |
Each level in the list will be one of our [Canonical Job Title Levels](https://docs.peopledatalabs.com/docs/job-title-levels).
Note: The cxo level is a catch-all for "Chief \_*Officer" roles, so a CEO, CIO, CTO, etc. will all have job*title\_levels: \["cxo"].
### `data.dataset_version`
| Type | Description |
| :------- | :--------------------------------------- |
| `String` | The release number for the current build |