Output Response - Person Identify API

Response Data Structure

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

{
  "status": 200,
  "matches": [
    {
      "data": {
        ...
      },
      "match_score": 92,
      "matched_on": [
        "company",
        "name"
      ]
    },
    {
      "data": {
        ...
      },
      "match_score": 5,
      "matched_on": [
        "name"
      ]
    },
    ...
  ]
}

Response Fields

status

matches

Each object returned in the matches array will have the following attributes:

matches.match_score

match_score measures how strongly a profile matches the input search criteria. The score is used to rank matching profiles and filter out profiles below a given score (default 5).

The more specific the input criteria is, the more useful the match_score becomes. For example, if you wanted to find "John Smith", there would be too many possible matches. However, if you searched for "John Smith in New York City with the email address ___", it is much more likely that the profile with the highest match_score is the person you're looking for.

matches.data

matches.matched_on

See the include_if_matched input parameter for more details.

Errors

Any request that does not return a 200 success response will instead use the format described in Errors.