Endpoint

The endpoint for the Person Identify API is https://api.peopledatalabs.com/v5/person/identify.

Person Identify API Access and Billing

The Person Identify API is currently available only to enterprise customers. In order to request access to this endpoint, please speak to our sales team.

🚧

Warning: Credit Usage

Each call that you make to the Person Identify API will consume one credit, regardless of the number of profiles that the API returns.

This behavior differs from that of our other APIs, which consume one credit for each profile that they return.

Rate Limiting

The default rate limit for all customers is 10 calls per minute.

Input Parameters

📘

For More Details, See Person Identify API - Input Parameters

You can also click on the individual parameter names in the table below to view more information on them.

Note (*): While we don't require any of these parameters individually, you must provide a sufficient combination of them as inputs. For more details, see the minimum required inputs.

Output Response

Response Fields

📘

For More Details, See Person Identify API - Output Response

You can also click on the individual parameter names in the table below to view more information on them.

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"
      ]
    },
    ...
  ]
}

Errors

If the request encounters an error, it will instead return an Error Response in the format described in Errors.