Enrich
Enrich person
Match a person with our database and enrich it with additional information.
Cost: 3 credits
Webhook result: Documentation
Query Parameters
apiToken?string | null
Header Parameters
x-api-token?string | null
personPerson
The person to match with
company?Company
The company to match the person with
revealEmails?RevealEmails
Example
{"includeEmails":true,"webhookUrl":"https://url.com/webhook"}revealPhones?RevealPhones
Example
{"includePhones":true,"webhookUrl":"https://url.com/webhook"}Response Body
curl -X POST "https://api.ocean.io/v2/enrich/person?apiToken=string" \
-H "x-api-token: string" \
-H "Content-Type: application/json" \
-d '{
"person": {}
}'{
"id": "e9447c74eafa8a19",
"domain": "google.com",
"name": "John Doe",
"firstName": "John",
"lastName": "Doe",
"country": "us",
"state": "CA",
"location": "Copenhagen, Capital Region, Denmark",
"linkedinUrl": "https://www.linkedin.com/in/someone",
"seniorities": [
"C-Level",
"Manager"
],
"departments": [
"Management",
"Marketing and Advertising"
],
"photo": "http://media.licdn.com/dms/image/somelink",
"jobTitle": "Professeur",
"jobTitleEnglish": "Teacher",
"currentJobDescription": "Software Engineer specializing in cloud infrastructure",
"experiences": [
{
"dateFrom": "2020-01-01",
"dateTo": "2021-01-01",
"description": "Software Engineer specializing in cloud infrastructure",
"domain": "domain.com",
"jobTitle": "Software Engineer"
}
],
"summary": "Some text that the person wrote to describe themselves",
"skills": [
"Product Management",
"Entrepreneurship",
"Social Media"
],
"phone": {
"numbers": [
"+4512345678",
"+33 6 00 00 00 00"
],
"status": "verified"
},
"email": {
"address": "example.jonas@ocean.io",
"status": "verified"
}
}{
"detail": "Data gathering process has started. Please try again later."
}{
"detail": "Conflicting API tokens provided in query parameters and headers"
}{
"detail": "Insufficient credits"
}{
"detail": "API token should be provided in headers or query parameters"
}{
"detail": "No matching record found"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}