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

# Reference - Company Enrichment API

The Company Enrichment API provides a **one-to-one** company match. The company data provided by this endpoint includes all the fields in our [Company Schema](https://docs.peopledatalabs.com/docs/company-fields).

# Endpoint

The endpoint for the Company Enrichment API is `https://api.peopledatalabs.com/v5/company/enrich`.

# Company Enrichment API Access and Billing

When the API finds a matching company, it returns this company along with an HTTP response code of `200`. When it doesn't find a matching company, it returns an HTTP response code of `404`. We charge **per match**.

# Requests

See [Authentication](https://docs.peopledatalabs.com/docs/authentication) and [Requests](https://docs.peopledatalabs.com/docs/requests) for how to input requests. We recommend using a JSON object to capture request parameters and will do so in the examples.

# Rate Limiting

The standard rate limit is 10 per minute for free customers and 1,000 per minute for paying customers.

# Input Parameters

When querying the API in URL, you can add data points to a queried company as key/value pairs at the end of a `v5` request string.

You can use the following parameters to specify information about the requested company. Adding more data points to a request increases the probability of a `200` response and increases the [likelihood score](https://docs.peopledatalabs.com/docs/output-response-company-enrichment-api#likelihood-score). Adding unique parameters such as `website`, `ticker` or `profile` are more likely to yield a match than a `name`.

> 📘 For More Details, See [Input Parameters - Company Enrichment API](https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api)
>
> You can also click on the individual parameter names in the table below to view more information on them.

<HTMLBlock>
  {`
  <table style="width: 100%; border-collapse: collapse;">
  <thead>
  <tr>
    <th style="border: 1px solid #ddd; padding: 8px;">Parameter Name</th>
    <th style="border: 1px solid #ddd; padding: 8px;">Description</th>
    <th style="border: 1px solid #ddd; padding: 8px;">Example</th>
  </tr>
  </thead>
  <tbody>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#pdl_id"><code>pdl_id</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The PDL ID for a record in our Company Dataset.  </p>
  <p><strong>Note</strong>: If you enrich on ID and anything else, only ID is used and the other inputs for matching are ignored.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>aKCIYBNF9ey6o5CjHCCO4goHYKlf</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#name"><code>name</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s name.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>Google, Inc.</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#profile"><code>profile</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s social profile.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>linkedin.com/company/google</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#ticker"><code>ticker</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s stock ticker, if publicly traded.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>GOOGL</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#website"><code>website</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s website.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>google.com</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#location"><code>location</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The complete or partial company location. You can input multiple location values.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>1600 Amphitheatre Pkwy, Mountain View, CA 94043 </code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#locality"><code>locality</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s locality. You can only input one locality.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>mountainview</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#region"><code>region</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s region. You can only input one region.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>california</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#country"><code>country</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s country. You can only input one country.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>united states</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#street_address"><code>street_address</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s street address. You can only input one street address.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>1600 Amphitheatre Pkwy</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#postal_code"><code>postal_code</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The company&#39;s postal code. You can only input one postal code.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>94043</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#api_key"><code>api_key</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>Your secret API key. <strong>Note</strong>: You can also provide this in the request header instead, as shown on the <a href="https://docs.peopledatalabs.com/docs/authentication">Authentication</a> page.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"></td>
  </tr>
  </tbody>
  </table>
  `}
</HTMLBlock>

For our Company Enrichment API, we require a *non-ambiguous* match. This means that you must input a `name` OR `ticker` OR `website` OR `profile`.

## Additional Input Parameters

You are not required to use the following additional input parameters. They generally transform or control various aspects of the enrichment process (returning matches or formatting results.)

<HTMLBlock>
  {`
  <table style="width: 100%; border-collapse: collapse;">
  <thead>
  <tr>
    <th style="border: 1px solid #ddd; padding: 8px;">Parameter Name</th>
    <th style="border: 1px solid #ddd; padding: 8px;">Description</th>
    <th style="border: 1px solid #ddd; padding: 8px;">Default</th>
    <th style="border: 1px solid #ddd; padding: 8px;">Example</th>
  </tr>
  </thead>
  <tbody>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#titlecase"><code>titlecase</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>All text in API responses returns as lowercase by default. Setting titlecase to <code>true</code> will titlecase the person data in <code>200</code> responses.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>false</code></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>true</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#pretty"><code>pretty</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>Whether the output should have <a href="http://jsonprettyprint.net/">human-readable</a> indentation.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>false</code></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>true</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#include_if_matched"><code>include_if_matched</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>If <code>true</code>, the response includes the top-level field <code>matched</code> (along with <code>data</code>, <code>status</code> and so forth),  which includes a value for each queried field parameter that was matched during our internal query.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>false</code></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>true</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#min_likelihood"><code>min_likelihood</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The minimum <code>likelihood</code> score that a response must have to return a <code>200</code>.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>2</code></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>6</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#min_likelihood"><code>required</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>The fields a response must have to return a <code>200</code>.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"></td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>ticker</code></p>
  </td>
  </tr>
  <tr>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><a href="https://docs.peopledatalabs.com/docs/input-parameters-company-enrichment-api#data_include"><code>data_include</code></a></p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p>A comma-separated string of fields that you want the response to include.  </p>
  <p>Begin the string with a <code>-</code> if you want to <em>exclude</em> the specified fields. If you want to exclude all data from being returned, use <code>data_include=&quot;&quot;</code>.</p>
  </td>
    <td style="border: 1px solid #ddd; padding: 8px;"></td>
    <td style="border: 1px solid #ddd; padding: 8px;"><p><code>&quot;full_name,emails.address&quot;</code></p>
  </td>
  </tr>
  </tbody>
  </table>
  `}
</HTMLBlock>

# Output Response

When you execute an API request, we preprocess the queried data points and build them into a query, which we then execute against our [Company Dataset](https://docs.peopledatalabs.com/docs/company-stats). Most profiles and websites map to a unique company. We fuzzy-match company names based on name appearance relative to different unique company profiles. The company name that appears most frequently in our data is the one that is most likely to be the company returned in a `200` HTTP response code. If we do not find a match or cannot resolve the query to a unique company based on a `name`, we will return a `404` HTTP response code.

## Response Fields

> 📘 For More Details, See [Output Response - Company Enrichment API](https://docs.peopledatalabs.com/docs/output-response-company-enrichment-api)
>
> You can also click the field names in the table below to view more information on them.

| Field                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                           | Type      |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| [`status`](https://docs.peopledatalabs.com/docs/output-response-company-enrichment-api#status)          | The response code (see a description of our [error codes](errors)).                                                                                                                                                                                                                                                                                   | `Integer` |
| [`likelihood `](https://docs.peopledatalabs.com/docs/output-response-company-enrichment-api#likelihood) | The degree of confidence. The field is an integer between `1` and `10` that represents how confident we are that the company that we returned is the same as the company that you requested. You can control the minimum likelihood score a response must have in order to return a `200` by using the `min_likelihood` parameter in the API request. | `Integer` |
| [`*`](https://docs.peopledatalabs.com/docs/output-response-company-enrichment-api#section-)             | The matched profile record containing fields from our [Company Schema](https://docs.peopledatalabs.com/docs/company-fields). Any fields in the profile record that do not contain any data will have a `null` value.                                                                                                                                                                   |           |

## Response Data Structure

Here is an example response from the Company Enrichment API:

```json
{
  "status": 200,
  "name": "people data labs",
  "id": "tnHcNHbCv8MKeLh92946LAkX6PKg",
  ...,
  "likelihood": 6
}
```

See [Example Company Record](https://docs.peopledatalabs.com/docs/example-company-record) for a full example of the fields included in the response object.

## Errors

If the request encounters an error, it will instead return an Error Response in the format described in [Errors](https://docs.peopledatalabs.com/docs/errors).