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

# Input Parameters - Cleaner APIs

## Company Cleaner API Parameters (`/company/clean`)

While all parameters are optional, we require a *non-ambiguous* match. This means that you must input a `name` OR `website` OR `profile`.

### `name`

| Parameter Name | Required | Description                                                                                                                                                     | Example            |
| :------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------- |
| `name`         | No       | The name of the company that you want to identify. We accept unformatted strings with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `People data Labs` |

### `profile `

| Parameter Name | Required | Description                                                                                                                                                                | Example                       |
| :------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------- |
| `profile `     | No       | The social profile URL of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `linkedin.com/company/google` |

### `website `

| Parameter Name | Required | Description                                                                                                                                                     | Example                  |
| :------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------- |
| `website `     | No       | The website of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `www.peopledatalabs.com` |

### `pretty `

| Parameter Name | Required | Description                                                | Example |
| :------------- | :------- | :--------------------------------------------------------- | :------ |
| `pretty `      | No       | Whether the output should have human-readable indentation. | `True ` |

### `api_key `

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

      <th>
        Required
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `api_key`
      </td>

      <td>
        No\*
      </td>

      <td>
        Your secret API key.

        While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the `x-api-key` field in the headers. For more information, see the [Authentication](https://docs.peopledatalabs.com/docs/authentication) page.
      </td>

      <td />
    </tr>
  </tbody>
</Table>

<br />

***

## Location Cleaner API (`/location/clean`)

### `location `

| Parameter Name | Required | Description                                                                                                                                                        | Example         |
| :------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- |
| `location `    | Yes      | The name of the location that you want to identify. We accept unformatted locations with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `San Francisco` |

### `pretty `

| Parameter Name | Required | Description                                                | Example |
| :------------- | :------- | :--------------------------------------------------------- | :------ |
| `pretty `      | No       | Whether the output should have human-readable indentation. | `True ` |

### `api_key `

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

      <th>
        Required
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `api_key`
      </td>

      <td>
        No\*
      </td>

      <td>
        Your secret API key.

        While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the `x-api-key` field in the headers. For more information, see the [Authentication](https://docs.peopledatalabs.com/docs/authentication) page.
      </td>

      <td />
    </tr>
  </tbody>
</Table>

<br />

***

## School Cleaner API (`/school/clean`)

While all parameters are optional, we require a *non-ambiguous* match. This means that you must input a `name` OR `website` OR `profile`.

### `name`

| Parameter Name | Required | Description                                                                                                                                                     | Example   |
| :------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------- |
| `name`         | No       | The name of the company that you want to identify. We accept unformatted strings with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `Harvard` |

### `profile `

| Parameter Name | Required | Description                                                                                                                                                                | Example                                  |
| :------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------- |
| `profile `     | No       | The social profile URL of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `linkedin.com/school/harvard-university` |

### `website `

| Parameter Name | Required | Description                                                                                                                                                     | Example        |
| :------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------- |
| `website `     | No       | The website of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | `hardvard.edu` |

### `pretty `

| Parameter Name | Required | Description                                                | Example |
| :------------- | :------- | :--------------------------------------------------------- | :------ |
| `pretty `      | No       | Whether the output should have human-readable indentation. | `True ` |

### `api_key `

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

      <th>
        Required
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `api_key`
      </td>

      <td>
        No\*
      </td>

      <td>
        Your secret API key.

        While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the `x-api-key` field in the headers. For more information, see the [Authentication](https://docs.peopledatalabs.com/docs/authentication) page.
      </td>

      <td />
    </tr>
  </tbody>
</Table>