The Person Enrichment API provides a one-to-one person match, retrieving up-to-date information on a unique individual.

Endpoint

The endpoint for the Person Enrichment API is https://api.peopledatalabs.com/v5/person/enrich.

Person Enrichment API Access and Billing

You can access the Person Enrichment API through our self-signup dashboard

When the API finds a matching person, it returns this person along with an HTTP response code of 200. When it doesn't find a matching person, it returns an HTTP response code of 404. We charge per match.

Requests

See Authentication and Requests sections to see all possible ways to input a request. We recommend using a JSON object to capture input parameters and will do so in the examples.

Rate Limiting

Our default limit for free customers is 100 per minute. Our default limit for paying customers is 1,000 per minute.

Note: To allow for more enrichments without putting too much strain on our system, you can use the Bulk Person Enrichment API to increase the number of enrichments per request, effectively increasing your rate limit by up to a hundred times.

Input Parameters

When querying the API in URL, you can add data points to a queried person as key/value pairs at the end of a v5 request string.

You can use the following parameters to specify information on a requested person. Adding more data points to a request increases the probability of a 200 response and will further increase the accuracy of the response's Likelihood Score.

All query parameters listed below are optional.

📘

For more details, see Input Parameters - Person Enrichment API

You can also click on the individual parameter names in the table below to view more information on them.

Additional Input Parameters

You are not required to use the following additional input parameters. They generally transform or control various aspects of the enrichment process (returning matches or formatting results.)

Minimum Inputs

The minimum combination of data points that a request must contain in order to return a 200 response are:

profile OR email OR phone OR email_hash OR lid OR ( 
    (
        (first_name AND last_name) OR name) AND 
        (locality OR region OR company OR school OR location OR postal_code)
    )

Output Response

When you execute an API request, we preprocess the queried data points and build them into a query, which we then execute against our API dataset. If the query yields one or more matching persons from the dataset, we return in the API response the person who is most likely the person requested, along with a 200 HTTP response code. If we do not find a match, we return a 404 HTTP response code.

Response Fields

📘

For more details, see Output Response - Person Enrichment API

You can also click the field names in the table below to view more information on them.

Response Data Structure

Here is an example response from the Person Enrichment API:

{
    "status": 200,
    "likelihood": 10,
    "data":  {
            "id": "qEnOZ5Oh0poWnQ1luFBfVw_0000",
            "full_name": "sean thorne",
            ...
     }
}

See Example Person Record for a full example of the fields included in the data object.

Errors

If the request encounters an error, it will instead return an Error Response in the format described in Errors.