> ## 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 - IP Enrichment API

## Required Parameters

### `api_key`

| Type     | Description          | Default | Example |
| :------- | :------------------- | :------ | :------ |
| `String` | Your secret API key. |         |         |

Your API Key **must** be included in either the request header or the api\_key parameter. For more information about request authentication, see the [Authentication](https://docs.peopledatalabs.com/docs/authentication) page.

<br />

### `ip`

| Type     | Description                                      | Example         |
| :------- | :----------------------------------------------- | :-------------- |
| `String` | The IP address to enrich in IPv4 or IPv6 format. | `72.212.42.169` |

***

## Optional Parameters

### `return_ip_location`

| Type      | Description                                                                                                                                                                     | Default | Example |
| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------ | :------ |
| `Boolean` | IP responses will not include location data for the IP by default.  Setting `return_ip_location` to `true` will return IP specific location info regardless of a company match. | `false` | `true`  |

<br />

### `return_ip_metadata`

| Type      | Description                                                                                                                                                           | Default | Example |
| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :------ |
| `Boolean` | IP responses will not include metadata for the IP by default.  Setting `return_ip_metadata` to `true` will return IP specific metadata regardless of a company match. | `false` | `true`  |

<br />

### `return_if_unmatched`

| Type      | Description                                                                                                              | Default | Example |
| :-------- | :----------------------------------------------------------------------------------------------------------------------- | :------ | :------ |
| `Boolean` | Setting `return_if_unmatched` to `true` will return IP specific metadata or location data regardless of a company match. | `false` | `true`  |

<br />

### `return_person`

| Type      | Description                                                                         | Default | Example |
| :-------- | :---------------------------------------------------------------------------------- | :------ | :------ |
| `Boolean` | Setting `return_person` to `true` will return person fields associated with the IP. | `false` | `true`  |

<br />

### `min_confidence`

| Type            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Default | Example |
| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------ | :------ |
| `Enum [String]` | Returns responses if they are equal to or higher confidence than the defined parameter. For example, setting `min_confidence` to `high` will only return responses if [`company.confidence`](https://docs.peopledatalabs.com/docs/ip-fields#companyconfidence) and [`person.confidence`](https://docs.peopledatalabs.com/docs/ip-fields#personconfidence) is `high` or `very high`. See [canonical values](https://docs.peopledatalabs.com/docs/confidence-levels) for a list of accepted values. |         | `high`  |

<br />

### `pretty`

| Type      | Description                                                                               | Default | Example |
| :-------- | :---------------------------------------------------------------------------------------- | :------ | :------ |
| `Boolean` | Whether the output should have [human-readable](http://jsonprettyprint.net/) indentation. | `false` | `true`  |

<br />

### `titlecase`

| Type      | Description                                                                                                                    | Default | Example |
| :-------- | :----------------------------------------------------------------------------------------------------------------------------- | :------ | :------ |
| `Boolean` | All text in API responses returns as lowercase by default. Setting `titlecase` to `true` will titlecase response data instead. | `false` | `true`  |