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

# People Data Labs: Person Identify

> Find the profiles that best match partial person details, ranked by how well each matches. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Find the profiles that best match partial person details, ranked by how well each matches.

> [!NOTE]
>
> Tool ID: `peopledatalabs_person_identify`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'peopledatalabs_person_identify',
  {
    "profile": "example",
    "email": "jane.doe@example.com",
    "phone": "+14155550123",
    "first_name": "Jane",
    "last_name": "Doe",
    "company": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute peopledatalabs_person_identify --input '{
  "profile": "example",
  "email": "jane.doe@example.com",
  "phone": "+14155550123",
  "first_name": "Jane",
  "last_name": "Doe",
  "company": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "matches": [
      {
        "match": 123,
        "data": {
          "id": "id_123",
          "full_name": "Example",
          "first_name": "Jane"
        }
      }
    ],
    "warnings": [
      {}
    ],
    "error": "example"
  }
}
```

Use `deepline describe peopledatalabs_person_identify --json` for the latest machine-readable contract.

## Input reference

People Data Labs person identify input for ambiguous lookups (returns ranked candidate profiles).

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.profile` | `string` | No | — | LinkedIn profile URL. |
| `payload.email` | `string` | No | — | Email address. |
| `payload.phone` | `string` | No | — | Phone number. |
| `payload.email_hash` | `string` | No | — | Hashed email identifier. |
| `payload.lid` | `string` | No | — | PDL legacy person ID. |
| `payload.street_address` | `string` | No | — | Street address for matching. |
| `payload.locality` | `string` | No | — | City/locality. |
| `payload.region` | `string` | No | — | State/region. |
| `payload.country` | `string` | No | — | Country. |
| `payload.company` | `string` | No | — | Company name or domain context. |
| `payload.school` | `string` | No | — | School name context. |
| `payload.location` | `string` | No | — | Free-form location string. |
| `payload.postal_code` | `string` | No | — | Postal/ZIP code. |
| `payload.name` | `string` | No | — | Full name. |
| `payload.first_name` | `string` | No | — | First name. |
| `payload.last_name` | `string` | No | — | Last name. |
| `payload.middle_name` | `string` | No | — | Middle name. |
| `payload.birth_date` | `string` | No | — | Birth date (if known). |
| `payload.pretty` | `boolean` | No | — | Pretty-print response JSON. |
| `payload.titlecase` | `boolean` | No | — | Normalize output text casing. |
| `payload.data_include` | `string` | No | — | Comma-separated fields to include, or a leading - list to exclude. This changes response fields and payload size only. It does not change Person Identify billing. |
| `payload.include_if_matched` | `boolean` | No | — | Include additional response payload when matches are found. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "People Data Labs person identify input for ambiguous lookups (returns ranked candidate profiles).",
    "properties": {
      "profile": {
        "type": "string",
        "description": "LinkedIn profile URL."
      },
      "email": {
        "type": "string",
        "description": "Email address."
      },
      "phone": {
        "type": "string",
        "description": "Phone number."
      },
      "email_hash": {
        "type": "string",
        "description": "Hashed email identifier."
      },
      "lid": {
        "type": "string",
        "description": "PDL legacy person ID."
      },
      "street_address": {
        "type": "string",
        "description": "Street address for matching."
      },
      "locality": {
        "type": "string",
        "description": "City/locality."
      },
      "region": {
        "type": "string",
        "description": "State/region."
      },
      "country": {
        "type": "string",
        "description": "Country."
      },
      "company": {
        "type": "string",
        "description": "Company name or domain context."
      },
      "school": {
        "type": "string",
        "description": "School name context."
      },
      "location": {
        "type": "string",
        "description": "Free-form location string."
      },
      "postal_code": {
        "type": "string",
        "description": "Postal/ZIP code."
      },
      "name": {
        "type": "string",
        "description": "Full name."
      },
      "first_name": {
        "type": "string",
        "description": "First name."
      },
      "last_name": {
        "type": "string",
        "description": "Last name."
      },
      "middle_name": {
        "type": "string",
        "description": "Middle name."
      },
      "birth_date": {
        "type": "string",
        "description": "Birth date (if known)."
      },
      "pretty": {
        "type": "boolean",
        "description": "Pretty-print response JSON."
      },
      "titlecase": {
        "type": "boolean",
        "description": "Normalize output text casing."
      },
      "data_include": {
        "type": "string",
        "description": "Comma-separated fields to include, or a leading - list to exclude. This changes response fields and payload size only; it does not change Person Identify billing."
      },
      "include_if_matched": {
        "type": "boolean",
        "description": "Include additional response payload when matches are found."
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

People Data Labs person identify result with ranked candidate matches for disambiguation.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.matches` | `array` | No | — | — |
| `result.data.matches[].match` | `number` | No | — | — |
| `result.data.matches[].data` | `object` | No | — | PDL person record. |
| `result.data.matches[].data.id` | `string` | No | — | — |
| `result.data.matches[].data.full_name` | `string` | No | — | — |
| `result.data.matches[].data.first_name` | `string` | No | — | — |
| `result.data.matches[].data.last_name` | `string` | No | — | — |
| `result.data.matches[].data.linkedin_url` | `string \| null` | No | — | — |
| `result.data.matches[].data.work_email` | `string \| null` | No | — | — |
| `result.data.matches[].data.emails` | `array` | No | — | — |
| `result.data.matches[].data.personal_emails` | `array` | No | — | — |
| `result.data.matches[].data.recommended_personal_email` | `string \| null` | No | — | — |
| `result.data.matches[].data.mobile_phone` | `string \| null` | No | — | — |
| `result.data.matches[].data.phone_numbers` | `array` | No | — | — |
| `result.data.matches[].data.job_title` | `string \| null` | No | — | — |
| `result.data.matches[].data.job_company_name` | `string \| null` | No | — | — |
| `result.data.matches[].data.location_name` | `string \| null` | No | — | — |
| `result.data.warnings` | `array` | No | — | — |
| `result.data.error` | `string` | No | — | — |
| `result.data.status` | `number` | No | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "People Data Labs person identify result with ranked candidate matches for disambiguation.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Provider response payload.",
        "properties": {
          "matches": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "match": {
                  "type": "number"
                },
                "data": {
                  "type": "object",
                  "description": "PDL person record.",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "full_name": {
                      "type": "string"
                    },
                    "first_name": {
                      "type": "string"
                    },
                    "last_name": {
                      "type": "string"
                    },
                    "linkedin_url": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "work_email": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "emails": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "additionalProperties": {}
                      }
                    },
                    "personal_emails": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "recommended_personal_email": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "mobile_phone": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "phone_numbers": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "job_title": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "job_company_name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "location_name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          },
          "warnings": {
            "type": "array",
            "items": {}
          },
          "error": {
            "type": "string"
          },
          "status": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `6.16` per pricing unit.

## Related documentation

* [People Data Labs provider guide](https://deepline.com/docs/providers/peopledatalabs/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.