FAQs - Person Search API

Miscellaneous (but useful) information on the Person Search API

👍

Have a question you want answered? Ask us!

You can either use the Suggest Edits button in the top right hand corner of this page to ask a question or post your question in our Roadmap Board.


Q: Can I get a likelihood score in the Person Search API?

Answer The likelihood score that we return in our Enrichment API represents the likelihood on the matching logic given the input parameters, so it wouldn't be relevant in the Person Search API.

Q: Can I use the Person Search API to enrich data?

Answer The nuances in our Person Enrichment API matching logic are ignored in the Person Search API. We don't do any pre-processing (cleaning) of the inputs to the Person Search API, so you're almost guaranteed to have a lower match rate.

Additionally, the Person Search API queries and enrichment are structured differently. When a Person Enrichment API request is made, we have a custom-built query that takes the different input parameters and weights them differently, only returning a match in certain cases and stack ranking in cases where there are multiple matches (for example, John Smith in San Francisco.)

Q: Should I use SQL or Elasticsearch for the Person Search API?

Answer

Use Elasticsearch when:

  1. You have complicated boolean queries that require nested logic.
  2. You want to maximize the control that you have over text based matching (titles, summaries and so forth.)
  3. You have comfort writing Elasticsearch queries.

Use SQL when:

  1. You are running simple searches with only a few parameters.
  2. You're exclusively using ENUM parameters from the PDL data (location, company, major and so forth.)
  3. You have comfort writing SQL queries,

Q: Why is there a 1MB limit on the API response/body?

Answer The error message is not actually an API response but an error that exists whenever the query is too large and cURL can't handle the response. Calling the API with Python should alleviate this issue as Python compresses the extra space within an ES query. Additional ways to decrease the query size would be to reduce the profile count parameter from 100 to 60 for each call and to remove the `pretty` tag.

Q: Can I exclude PDL IDs in a Person Search call to avoid spending duplicate credits?

Answer No. The API isn’t designed to exclude by PDL ID. But the Person Retrieve API may achieve what you're aiming for.

Did this page help you?