Enrich Person
/unified/enrichment/person/enrich
Query Parameters
Refer Specifying query parameters in Truto APIs
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
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.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
The company the person works at. Used with a name to identify the person.
4 supported
ApolloThe company's primary website domain, without protocol or path.
The unique identifier of the company in the provider.
The URL of the company's LinkedIn page.
The name of the company.
An email address of the person.
3 supported
ApolloThe first name of the person.
4 supported
ApolloAlso return personal email addresses. Off by default. May use extra provider credits.
2 supported
Also return phone numbers. Off by default. Providers often charge several times more for a phone number than for a profile.
2 supported
The last name of the person.
4 supported
ApolloThe URL of the person's LinkedIn profile.
4 supported
ApolloThe full name of the person.
4 supported
ApolloAny 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
The unique identifier of the person in the provider.
4 supported
ApolloThe URL of the person's profile photo.
2 supported
ApolloThe company the person currently works at. Its domain or LinkedIn URL can be passed to the company enrich method.
4 supported
ApolloThe company's primary website domain, without protocol or path.
The unique identifier of the company in the provider.
The URL of the company's LinkedIn page.
The name of the company.
The email addresses of the person.
3 supported
ApolloThe email address.
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.
verifiedriskyinvalidsuppressedunknown
Whether the address is a work or a personal address.
workpersonalunknown
The first name of the person.
4 supported
ApolloThe short professional summary line shown on the person's public profile.
3 supported
ApolloThe last name of the person.
4 supported
ApolloThe URL of the person's LinkedIn profile.
4 supported
ApolloWhere the person is based.
3 supported
ApolloThe city.
The country name.
The state or region.
The full name of the person.
4 supported
ApolloThe phone numbers of the person. Most providers return phone numbers only when requested, and charge extra for them.
1 supported
The phone number.
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.
mobiledirectofficefaxpersonalotherunknown
Raw data returned from the remote API call.
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.
ownerfounderc_suitepartnervpheaddirectormanagerseniorentryinternotherunknown+ 1 more
3 supported
ApolloThe person's current job title.
4 supported
ApolloThe date and time the provider last updated its data for this person.
3 supported
Apollotruto unified enrichment person \
-m enrich \
-a '<integrated_account_id>' \
-o jsonimport 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);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 -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": {}
}'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);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())