> ## 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. # IP Schema {` `} # Overview [IP Enrichment API](https://docs.peopledatalabs.com/docs/ip-enrichment-api) This page details the company-related fields that we provide through the [IP Enrichment API](https://docs.peopledatalabs.com/docs/ip-enrichment-api). > 📘 Field Availability > > Please note: Not all fields are available in all bundles. * For more information about data formatting, see [Data Types](https://docs.peopledatalabs.com/docs/data-types). * For a full example record, see [Example IP Record](https://docs.peopledatalabs.com/docs/example-ip-record). * For a simplified overview of our IP fields, check out the [IP Data Overview](https://docs.peopledatalabs.com/docs/ip-data-overview). * For more details about our IP fields and fill rates check out our [IP Stats](https://docs.peopledatalabs.com/docs/ip-stats) pages. * If you'd like access to premium fields or have questions about which fields are included in your specific field bundle(s), please [speak to one of our data consultants](https://peopledatalabs.com/talk-to-sales). *** ## IP ### `ip`

Description	Information related to the IP address.
Data Type	`Object`

#### Field Details This the object containing all information related to a particular IP we've registered in our dataset. IP objects can include the following data: | Field | Type | Description | | ------------- | --------- | --------------------------------------------------------------------------------------------------------------------- | | `ip.address` | `String ` | The matched IP address. | | `ip.metadata` | `Object ` | Premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services. | | `ip.location` | `Object ` | The location associated with the IP address. | #### Example ```json "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" } } ``` ### `ip.address`

Description	The IP address .
Data Type	`String`

#### Field Details This is the specific IP address we have registered in our dataset #### Example ```json "address": "72.212.42.169", ``` ### `ip.metadata`

Description	Premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services.
Data Type	`Object`

#### Field Details The `metadata` object is a set of premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services. #### Example ```json "metadata": { "version": 4, "mobile": false, "hosting": false, "proxy": false, "tor": false, "vpn": false, "relay": false, "service": null, "asn_domain": null } ``` ### `ip.metadata.version`

Description	The type of IP Address (IPv4 or IPv6).
Data Type	`Integer (4 or 6)`

#### Field Details This field will only contain the integer values `4` or `6` corresponding to whether the `ip.address` field is a IPv4 or IPv6 address. #### Example ```json "version": 4, ``` ### `ip.metadata.mobile`

Description	If the IP is a known mobile address.
Data Type	`Boolean`

#### Field Details A boolean field indicating whether the IP is a known mobile address. #### Example ```json "mobile": false, ``` ### `ip.metadata.hosting`

Description	If the IP is a known hosting address.
Data Type	`Boolean`

#### Field Details A boolean field indicating whether the IP is a known hosting address. #### Example ```json "hosting": false ``` ### `ip.metadata.proxy`

Description	If the IP is a known proxy address.
Data Type	`Boolean`

#### Field Details A boolean field indicating whether the IP is a known proxy address. #### Example ```json "proxy": false ``` ### `ip.metadata.tor`

Description	If the IP is a known Tor address.
Data Type	`Boolean`

#### Field Details A boolean field indicating whether the IP is a known Tor address. #### Example ```json "tor": false ``` ### `ip.metadata.vpn`

Description	If the IP is a known VPN address.
Data Type	`Boolean`

#### Field Details A boolean field indicating whether the IP is a known VPN address. #### Example ```json "vpn": false ``` ### `ip.metadata.relay`

Description	If the IP is a known relay address.
Data Type	`Boolean`

#### Field Details A boolean field indicating whether the IP is a known relay address. #### Example ```json "relay": false ``` ### `ip.metadata.service`

Description	If known, the name of the service for the address.
Data Type	`String`

#### Field Details If known, this field will contain the name of the service for the address. If the service name is unknown, the field value returned will be `null`. #### Example ```json "service": null ``` ### `ip.metadata.asn_domain`

Description	The domain associated with the ASN block.
Data Type	`String`

#### Field Details If known, this field will contain the domain associated with the ASN block for this IP. If the ASN block is unknown, the field value returned will be `null`. #### Example ```json "asn_domain": null ``` ## Location ### `ip.location`

Description	The location associated with the IP address.
Data Type	`Object`

#### Field Details 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). | For more information on our standard location fields, see ``. #### Example ```json "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" } ``` ### `ip.location.name`

Description	Our cleaned values for locations in the format locality, region, country.
Data Type	`String`

#### Example ```json "name": "phoenix, arizona, united states" ``` ### `ip.location.locality`

Description	The locality of the ip address
Data Type	`String`

#### Example ```json "locality": "phoenix" ``` ### `ip.location.region`

Description	The region of the ip address
Data Type	`String`

#### Example ```json "region": "arizona" ``` ### `ip.location.metro`

Description	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).
Data Type	`Enum (String)`

#### Example ```json "metro": "phoenix, arizona" ``` ### `ip.location.country`

Description	Standardized format for country. Will be one of our [Canonical Countries](https://docs.peopledatalabs.com/docs/location-countries).
Data Type	`Enum (String)`

#### Example ```json "country": "united states" ``` ### `ip.location.continent`

Description	Standardized format for continent. Will be one of our [Canonical Continents](https://docs.peopledatalabs.com/docs/location-continents).
Data Type	`Enum (String)`

#### Example ```json "continent": "north america" ``` ### `ip.location.postal_code`

Description	The postal code of the ip address
Data Type	`String`

#### Example ```json "postal_code": "85001" ``` ### `ip.location.geo`

Description	City-center geo code of a locality, in the format latitude, longitude.
Data Type	`String`

#### Example ```json "geo": "33.44838,-112.07404" ``` ### `ip.location.timezone`

Description	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 Type	`Enum (String)`

#### Example ```json "timezone": "america/phoenix" ``` ## Company ### `company`

Description	Information related to the company associated with the IP address
Data Type	`Object`

#### Field Details Many of the fields in the `data.company` object come directly from our [Company Schema](https://docs.peopledatalabs.com/docs/company-schema). #### Example ```json "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": "51-200", "industry": "computer software", "inferred_revenue": "$10M-$25M", "employee_count": 116, "tags": [ "b2b data", "people data", "data science", "data", "daas", "artificial intelligence", "data and analytics", "machine learning", "analytics", "database" ] } ``` ### `company.confidence`

Description	How confident we are that the returned company is associated with requested IP.
Data Type	`Enum (String)`

#### Field Details 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. #### Example ```json "confidence": "very high" ``` ### `company.id`

Description	The [PDL ID](https://docs.peopledatalabs.com/docs/company-schema#id) of the company associated with the IP address
Data Type	`String`

#### Field Details See [`company.id`](https://docs.peopledatalabs.com/docs/company-schema#id) for more information about how we handle company IDs. #### Example ```json "id": "tnHcNHbCv8MKeLh92946LAkX6PKg" ``` ### `company.website`

Description	The [primary website](https://docs.peopledatalabs.com/docs/company-schema#website) of the company associated with the IP address.
Data Type	`String`

#### Field Details See [`company.website`](https://docs.peopledatalabs.com/docs/company-schema#website) for more information about how we handle company websites. #### Example ```json "website": "peopledatalabs.com" ``` ### `company.name`

Description	The [name](https://docs.peopledatalabs.com/docs/company-schema#name) of the company associated with the IP address.
Data Type	`String`

#### Field Details See [`company.name`](https://docs.peopledatalabs.com/docs/company-schema#name) for more information about how we handle company names. #### Example ```json "name": "people data labs" ``` ### `company.display_name`

Description	The [display\_name](https://docs.peopledatalabs.com/docs/company-schema#display_name) of the company associated with the IP address.
Data Type	`String`

#### Field Details See [`company.display_name`](https://docs.peopledatalabs.com/docs/company-schema#display_name) for more information about how we handle company names. #### Example ```json "display_name": "People Data Labs" ``` ### `company.location`

Description	The [location](https://docs.peopledatalabs.com/docs/company-schema#location) of the company's primary HQ associated with the IP address
Data Type	`Object`

#### Field Details 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`. | #### Example ```json "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" }, ``` ### `company.location.name`

Description	Our cleaned values for locations in the format locality, region, country.
Data Type	`String`

#### Example ```json "name": "san francisco, california, united states" ``` ### `company.location.locality`

Description	The locality of the company HQ
Data Type	`String`

#### Example ```json "locality": "san francisco" ``` ### `company.location.region`

Description	The region of the company HQ
Data Type	`String`

#### Example ```json "region": "california" ``` ### `company.location.metro`

Description	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).
Data Type	`Enum (String)`

#### Example ```json "metro": "san francisco, california" ``` ### `company.location.country`

Description	Standardized format for country. Will be one of our [Canonical Countries](https://docs.peopledatalabs.com/docs/location-countries).
Data Type	`Enum (String)`

#### Example ```json "country": "united states" ``` ### `company.location.continent`

Description	Standardized format for continent. Will be one of our [Canonical Continents](https://docs.peopledatalabs.com/docs/location-continents).
Data Type	`Enum (String)`

#### Example ```json "continent": "north america" ``` ### `company.location.street_address`

Description	The street address of the company HQ
Data Type	`String`

#### Example ```json "street_address": "455 market street" ``` ### `company.location.address_line_2`

Description	The company HQ’s street address line 2
Data Type	`String`

#### Example ```json "address_line_2": "suite 1670" ``` ### `company.location.postal_code`

Description	The postal code of the company HQ
Data Type	`String`

#### Example ```json "postal_code": "94105" ``` ### `company.location.geo`

Description	City-center geo code of a locality, in the format latitude, longitude.
Data Type	`String`

#### Example ```json "geo": "37.77,-122.41" ``` ### `company.size`

Description	The self-reported [size range](https://docs.peopledatalabs.com/docs/company-sizes) of the company associated with the IP address.
Data Type	`Enum (String)`

#### Field Details See [`company.size`](https://docs.peopledatalabs.com/docs/company-schema#size) for more information about how we handle company size ranges. #### Example ```json "size": "51-200" ``` ### `company.industry`

Description	The self-reported [industry](https://docs.peopledatalabs.com/docs/industries) of the company associated with the IP address.
Data Type	`Enum (String)`

#### Field Details See [`company.industry`](https://docs.peopledatalabs.com/docs/company-schema#industry) for more information about how we handle company industries. #### Example ```json "industry": "computer software" ``` ### `company.inferred_revenue`

Description	The [estimated annual revenue](https://docs.peopledatalabs.com/docs/inferred-revenue-ranges) (in USD) of the company associated with the IP address.
Data Type	`Enum (String)`

#### Field Details See [`company.inferred_revenue`](https://docs.peopledatalabs.com/docs/company-schema#inferred_revenue) for more information about how we handle company revenues. #### Example ```json "inferred_revenue": "$10M-$25M" ``` ### `company.employee_count`

Description	The current [number of employees](https://docs.peopledatalabs.com/docs/company-schema#employee_count) working at the company associated with the IP address.
Data Type	`Integer (> 0)`

#### Field Details See [`company.employee_count`](https://docs.peopledatalabs.com/docs/company-schema#employee_count) for more information about how we handle company employee counts. #### Example ```json "employee_count": 116 ``` ### `company.tags`

Description	[Tags](https://docs.peopledatalabs.com/docs/company-schema#tags) associated with the company associated with the IP address.
Data Type	`Array \[String]`

#### Field Details See [`company.tags`](https://docs.peopledatalabs.com/docs/company-schema#tags) for more information about how we handle company tags. #### Example ```json "tags": [ "b2b data", "people data", "data science", "data", "daas", "artificial intelligence", "data and analytics", "machine learning", "analytics", "database" ] ``` ## Person ### `person`

Description	Information related to the person associated with the IP address
Data Type	`Object`

#### Field Details We offer several person-related fields within our IP records to understand the associated persona behind the IP. These fields are largely limited to job title information. #### Example ```json "person": { "confidence": "very high", "job_title_sub_role": "product", "job_title_role": "operations", "job_title_levels": [ "cxo" ], "job_title_class": "research_and_development" } ``` ### `person.confidence`

Description	How confident we are that the returned person is associated with requested IP.
Data Type	`Enum (String)`

#### Field Details Will be one of the following options: `very high`, `high`, `moderate`, `low`, `very low`. #### Example ```json "confidence": "very high" ``` ### `person.job_title_sub_role`

Description	The derived subrole of the person's current job title.
Data Type	`Enum (String)`

#### Field Details 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. #### Example ```json "job_title_sub_role": "product management" ``` ### `person.job_title_role`

Description	The derived role of the person's current job title.
Data Type	`Enum (String)`

#### Field Details The value will be one of our [Canonical Job Roles](https://docs.peopledatalabs.com/docs/job-title-roles). #### Example ```json "job_title_role": "product" ``` ### `person.levels`

Description	The derived level(s) of the person's current job title
Data Type	`Array \[Enum (String)]`

#### Field Details 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"]. #### Example ```json "job_title_levels": [ "cxo" ] ```
### `person.job_title_class`

Description	The line item category this employee would fall into.
Data Type	`Enum (String)`

#### Field Details The value will be one of our [Canonical Job Roles](https://docs.peopledatalabs.com/docs/job-title-class). #### Example ```json "job_title_class": "research_and_development" ``` ###