If you only want specific data, you should only pay for that specific data, which is why the Search API is priced per match. By specifying match criteria, you can define what you consider to be a match. You can specify a minimum criteria that a person must meet in order to be returned. If the criteria isn’t met, you will receive an empty response and won’t be charged.
There are three configuration parameters used to define match criteria:
When you want to specify the exact field or fields you need to be returned in the response, you should use the match_requirements configuration parameter. This parameter ensures that the response includes the ‘must have’ data field(s) you specified in the match_requirements parameter. If the response does not contain the data field(s) you specified in the match_requirements parameter, you’ll get a ‘non-matching response’ and you will not be billed for the request.
You can use one or more of these field names as atomic expressions in your match requirements condition: name, address, phone, email, job, education, image, username, user_id, dob, url, gender, language, origin_country or social_profile (any url, userID or username from a social media platform).
The criteria will be met if the response contains the requested field.
Possible person responses do not contain email addresses or social urls. Therefore, using match requirements of email or url will result in no possible person responses being returned. When using these match criteria, consider using the top_match parameter to include the email and social urls of the top possible person in a full person response.
You can only use match requirements on fields that are available in the key you are using. For example, if you are using the contact key which does not contain social media data, you will not be able to use "social_profiles" as a match requirement.
You can append “.TYPENAME” to any field name, where TYPENAME is any recognized @type value of the data field. See the Data Field pages to see the available @types that can be used for each data field. Some frequently used types include:
In addition to filtering by @type value, there are also a few subfields that can be used as match requirements which are name.first and name.last to require the presence of a first or last name respectively.
You can prefix any field name with “new_,” in which case the criteria will only be met if the response includes data of that type that was not included in the original query. Using this prefix is effective when you have a piece of data (e.g. an email) but want other data of the same field type (e.g. additional emails other than the one you have).
https://api.pipl.com/search/[email protected] &match_requirements=new_email &key=YOURKEY
The ‘new_’ prefix can also be used in combination with a search pointer search to check for any data updates after an interval of time (not more frequently than every 3 months).
The minimum_match parameter can be used to set a minimum match score required to return a match.
Pipl's identity resolution engine allocates a confidence match score between 0 and 1 for each person returned in a response. This match score (shown in the JSON response with the metadata indicator “@match”) indicates the confidence rating that the search engine found the person you’re looking for. Using data science, statistics, and probability, a match score is determined based on the query data entered and data returned from the available sources, a match of 1 is equivalent to 100% likelihood of that person being the one you’re searching for while 0.5 means 50% - for example, if there are 2 possible persons that matched your query. Please take into account that there is always room for minor error since we’re dealing with statistical models.
In the case that the Pipl identity resolution engine is confident that it found the person you’re looking for, it will return just one person with a match score of 1. This is referred to as a “[person response or a “perfect match profile”](ref: response-types#person-perfect-match)”.
When the Pipl identity resolution engine is not fully confident that it found the person you’re looking for, based on the search inputs you have supplied and the data found, it will return a response with a list of up to 50 possible-persons, one of which may be the person you are looking for. The possible-persons array is ordered in descending order of match score where the person with the highest match score is at the top of the list.
The match score (@match) is a very long decimal number but in the API response, this is rounded off to 2 digits after the decimal point. So even though persons in a possible_person response might appear to have the same match score, e.g 0.25, their actual match score could actually be different. Similarly a match score of 0.0 indicates a decimal number less than 0.05.
The minimum_match query parameter can be set at a decimal value between 0 and 1. When set, only person profiles with a match score above or equal to the minimum_match setting specified will be returned in a response.
When leaving the minimum match at the default setting of 0, there is no filtering on the match score, and all types of responses will be returned. For example, if you set the minimum_match to 0.5, only persons in the response that have a match score equal or higher than 0.5 will be returned. This means you will receive one of the following:
- a person response
- a possible_persons response with each person having a match score equal or above 0.5
- a non-matching response.
By setting the minimum_match to 1, you are telling the API to return only person responses (i.e. single matching profiles). This means you will never receive a possible_persons response and will only receive either
Also note that the top match feature is an alternative way to process possible person responses which will also eliminate possible person responses.
Finding the right minimum match level
If you are not sure what the right minimum_match is for you, first decide if you want to see possible person responses or not. If you only want to work with person responses, set the minimum_match to 1 or consider using the top match feature. If you are deciding on a minimum match between 0 and 1, start with any figure and slowly change it as you go. Lower it if you feel you might be missing data or raise it if you are getting too many irrelevant profiles.
See How to Handle Possible Person Responses for more details and options for handling possible person responses.
You can also use any of the source categories as the atomic expression. The criteria will be met if the response contains at least one person (perfectly matching or a possible person) that includes a source of the requested category. For example, setting source_category_requirements='personal_profiles' would only return a match if the response contained data from a personal social media profile. Setting the source category in the request is useful if you are only interested in a very specific piece of data that is related to one of the categories. Please note that in order to see the sources, you will need to set the show_sources parameter.
A match requirement or source category requirement may be either one atomic expression or two or more atomic expressions combined using the following operators and parentheses.
- " AND " : Both the preceding and the following expressions must be met.
- "|" or " OR ": Either the preceding or the following expression must be met.
Please note the following about using match criteria:
- Parentheses allow creating more complex rules. Whatever is inside a parenthesis will be evaluated to a truth value before the outer condition
- The source category requirements and match requirements are evaluated separately
- Incorrect structuring of match criteria will result in a error response(HTTP code 400)
https://api.pipl.com/search/[email protected] &match_requirements=(phone.mobile|email.personal) &minimum_match=0.5 &source_category_requirements=personal_profiles &key=YOURKEY
curl https://api.pipl.com/search/ \ -d [email protected] -d match_requirements=(emails.personal or phones.mobile) -d key=YOURKEY curl https://api.pipl.com/search/ \ -d [email protected] -d minimum_match=0.5 -d key=YOURKEY curl https://api.pipl.com/search/ \ -d [email protected] -d match_requirements=(emails and jobs) -d source_category_requirements=professional_and_business -d key=YOURKEY