Output Response - Person Enrichment API

Response Data Structure

The response from the Person Enrichment API will be in this format:

{
    "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.

Response Fields

data.*

The data object contains the entire PDL profile for the person that matches the Enrichment API request. Any profile field that we do not have data for will have a null value.

status

likelihood

We assign every match that the API finds during the enrichment process a likelihood score, to represent our confidence that the profile returned is the same as the profile requested. A score of 1 represents a very low confidence level while a score of 10 represents the highest degree of confidence. The likelihood score is logarithmic, so a response that returns a likelihood score of 2 will have roughly a 10-30% chance of being the person requested.

For example, enriching "John Smith" in "New York" is too vague for us to confidently say which of our profiles is the exact John Smith that you requested. However, if you were to attach an email, phone number, and street address to the request and they matched our data, we would be highly confident that we are returning the correct John Smith.

matched

See the include_if_matched input parameter for more details.