# Enrich Person

> Source: https://truto.one/docs/api-reference/unified-enrichment-api/person/enrich/

`POST /unified/enrichment/person/enrich`

Resource: **Person** · API: **Unified Enrichment API**

## Supported integrations

Apollo, Captain Data, LeadIQ, MoltSets

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_enforce_write_schema`** _(boolean)_
  Validates the request body against this method's `request_body_schema` before the request is sent to the underlying integration. When a field marked `required` is missing, Truto responds `400` with the missing field names under `truto_error_insight.missing_required_body_fields` instead of forwarding the call. Only the fields documented in `request_body_schema` are checked. A body carrying a non-empty `remote_data` object is forwarded unchecked, because `remote_data` is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under `truto_error_insight.conditionally_required_body_fields` rather than rejected. Some integrations declare fields `required` on `update` that the provider only requires on `create`; check `meta/{method}` for the resource before enabling this on update calls. If you sent an `Idempotency-Key` and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to `false`, which forwards the request as-is.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.

## Request body

- **`email`** _(string)_
  An email address of the person.
- **`linkedin_url`** _(string)_
  The URL of the person's LinkedIn profile.
- **`name`** _(string)_
  The full name of the person.
- **`first_name`** _(string)_
  The first name of the person.
- **`last_name`** _(string)_
  The last name of the person.
- **`company`** _(object)_
  The company the person works at. Used with a name to identify the person.
  - **`id`** _(string)_
    The unique identifier of the company in the provider.
  - **`name`** _(string)_
    The name of the company.
  - **`domain`** _(string)_
    The company's primary website domain, without protocol or path.
  - **`linkedin_url`** _(string)_
    The URL of the company's LinkedIn page.
- **`include_personal_emails`** _(boolean)_
  Also return personal email addresses. Off by default. May use extra provider credits.
- **`include_phones`** _(boolean)_
  Also return phone numbers. Off by default. Providers often charge several times more for a phone number than for a profile.
- **`remote_data`** _(object)_
  Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

## Response body

- **`id`** _(string, required)_
  The unique identifier of the person in the provider.
- **`name`** _(string)_
  The full name of the person.
- **`first_name`** _(string)_
  The first name of the person.
- **`last_name`** _(string)_
  The last name of the person.
- **`title`** _(string)_
  The person's current job title.
- **`headline`** _(string)_
  The short professional summary line shown on the person's public profile.
- **`seniority`** _(string)_
  The seniority of the person's current role. `other` is a level with no equivalent in this list, such as an unpaid or training role. `unknown` is a level the provider returned that could not be classified.
  Allowed: `owner`, `founder`, `c_suite`, `partner`, `vp`, `head`, `director`, `manager`, `senior`, `entry`, `intern`, `other` (+1 more)
- **`emails`** _(array<object>)_
  The email addresses of the person.
  - **`email`** _(string)_
    The email address.
  - **`type`** _(string)_
    Whether the address is a work or a personal address.
    Allowed: `work`, `personal`, `unknown`
  - **`status`** _(string)_
    The provider's assessment of whether email sent to the address will be delivered. `verified` means the provider checked it and expects delivery. `risky` means delivery is uncertain, for example a catch-all domain or a likely but unconfirmed address. `invalid` means the provider expects the address to bounce. `suppressed` means the provider advises against contacting the address. `unknown` means the provider has not assessed it.
    Allowed: `verified`, `risky`, `invalid`, `suppressed`, `unknown`
- **`phones`** _(array<object>)_
  The phone numbers of the person. Most providers return phone numbers only when requested, and charge extra for them.
  - **`number`** _(string)_
    The phone number.
  - **`type`** _(string)_
    The type of phone number. `direct` is a work line that reaches the person directly. `office` is a company main, headquarters or branch line. `personal` is a personal landline or a personal number of unknown device type.
    Allowed: `mobile`, `direct`, `office`, `fax`, `personal`, `other`, `unknown`
- **`location`** _(object)_
  Where the person is based.
  - **`city`** _(string)_
    The city.
  - **`state`** _(string)_
    The state or region.
  - **`country`** _(string)_
    The country name.
- **`linkedin_url`** _(string)_
  The URL of the person's LinkedIn profile.
- **`avatar`** _(string)_
  The URL of the person's profile photo.
- **`company`** _(object)_
  The company the person currently works at. Its domain or LinkedIn URL can be passed to the company enrich method.
  - **`id`** _(string)_
    The unique identifier of the company in the provider.
  - **`name`** _(string)_
    The name of the company.
  - **`domain`** _(string)_
    The company's primary website domain, without protocol or path.
  - **`linkedin_url`** _(string)_
    The URL of the company's LinkedIn page.
- **`updated_at`** _(string)_
  The date and time the provider last updated its data for this person.
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.

## Code examples

### Truto CLI

```bash
truto unified enrichment person \
  -m enrich \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

// Custom method: enrich
const result = await truto.unifiedApi.enrich(
  'enrichment',
  'person',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    # Custom method: enrich
    result = await truto_api.unified_api.enrich(
        "enrichment",
        "person",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
```

### curl

```bash
curl -X POST 'https://api.truto.one/unified/enrichment/person/enrich?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "your_email",
  "linkedin_url": "your_linkedin_url",
  "name": "your_name",
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "company": {},
  "include_personal_emails": true,
  "include_phones": true,
  "remote_data": {}
}'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const body = {
  "email": "your_email",
  "linkedin_url": "your_linkedin_url",
  "name": "your_name",
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "company": {},
  "include_personal_emails": true,
  "include_phones": true,
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/enrichment/person/enrich?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/enrichment/person/enrich"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "email": "your_email",
    "linkedin_url": "your_linkedin_url",
    "name": "your_name",
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "company": {},
    "include_personal_emails": True,
    "include_phones": True,
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())
```