> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peopledatalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Output Response - Person Identify API

## Response Data Structure

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

```json
{
  "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](https://docs.peopledatalabs.com/docs/errors). |

<br />

### `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`](#matchesmatch_score) greater than 5. |

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

<br />

### `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.

<br />

### `matches.data`

| Type     | Description                                         |
| :------- | :-------------------------------------------------- |
| `Object` | The full [person profile](https://docs.peopledatalabs.com/docs/fields) of the match. |

<br />

### `matches.matched_on`

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Array (String)`
      </td>

      <td>
        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](https://docs.peopledatalabs.com/docs/input-parameters-person-identify-api#include_if_matched) is set to `true`.
      </td>
    </tr>
  </tbody>
</Table>

See the [`include_if_matched` input parameter](https://docs.peopledatalabs.com/docs/input-parameters-person-identify-api#include_if_matched) for more details.

<br />

## Errors

Any request that does not return a `200` success response will instead use the format described in [Errors](https://docs.peopledatalabs.com/docs/errors).