Output Response - IP Enrichment API

Response Data Structure

Here is an example response from the IP Enrichment API:

{
    "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": "peopledatalabs",
            "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"
            ]
        }
    }
}

Response Fields

status

data

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

data.ip.address

The IP that matches the API input ip after it's passed through our validity checks.

data.ip.metadata

The metadata object is a premium add-on available for an additional price. It contains the following fields:

data.ip.location

The location object will contain some of our common location fields as well as the location timezone:

data.company

Many of the fields in the data.company object come directly from our Company Schema.

data.company.confidence

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

See company.id for more information about how we handle company IDs.

data.company.website

See company.website for more information about how we handle company websites.

data.company.name

See company.name for more information about how we handle company names.

data.company.display_name

See company.display_name for more information about how we handle company names.

data.company.location

The location object will contain our common location fields:

data.company.size

See company.size for more information about how we handle company size ranges.

data.company.industry

See company.industry for more information about how we handle company industries.

data.company.inferred_revenue

See company.inferred_revenue for more information about how we handle company revenues.

data.company.employee_count

See company.employee_count for more information about how we handle company employee counts.

data.company.tags

See company.tags for more information about how we handle company tags.

data.person

📘

Person Level Fields Are Coming Soon

If interested in learning more about these fields, please reach out to your Customer Success team or fill out our talk to sales form.

data.person.confidence

Will be one of the following options: very high, high, moderate, low, very low.

data.person.job_title_sub_role

The value will be one of our Canonical Job Sub Roles. Each subrole maps to a role. See https://docs.peopledatalabs.com/docs/title-subroles-to-roles for a complete mapping list.

data.person.job_title_role

The value will be one of our Canonical Job Roles.

data.person.job_title_levels

Each level in the list will be one of our Canonical 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"].