The response from the Person Enrichment API will be in this format:
"full_name": "sean thorne",
See Example Person Record for a full example of the fields included in the
|The matched profile record that contains fields from our Person Schema. Any fields in the profile record that do not contain any data will have a
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
|The API response code.
|How confident we are that the returned profile is the same as the person you requested. Will be an integer between
You can control the minimum likelihood score that a response must have in order to count as a match by setting the
min_likelihood parameter in the API request.
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.
|Every query input from the request that matched this profile.
IMPORTANT: This field will only be included in the response if the
include_if_matched flag is set to
include_if_matched input parameter for more details.
Updated 3 months ago