Output Response - Person Identify API

Detailed information on the output response that the Person Identify API returns

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`

Type	Description
`Integer`	The API response code.

`matches`

Type	Description
`Array (Object)`	A list of up to 20 profiles matching the input criteria from the API request. Only returns profiles with a `match_score` greater than 5.

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

`matches.match_score`

Type	Description
`Integer`	How likely that this record is the record you're looking for based on your query. Will be between `1-99`.

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`

Type	Description
`Object`	The full person profile of the match.

`matches.matched_on`

Type	Description
`Array (String)`	Which fields in the input query match the results in the returned profile. IMPORTANT: This field will only be included in the response if the `include_if_matched` flag is set to `true`.

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.

Updated 5 months ago