Enrich person

Webhook result: Documentation

Quickstart#

curl -X POST "https://api.ocean.io/v2/enrich/person" \
  -H "X-Api-Token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "person": {
      "linkedin": "linkedin.com/in/jane-doe-123"
    }
  }'

import requests

response = requests.post(
    'https://api.ocean.io/v2/enrich/person',
    headers={'X-Api-Token': 'YOUR_API_TOKEN'},
    json={'person': {'linkedin': 'linkedin.com/in/jane-doe-123'}},
)
data = response.json()

const response = await fetch('https://api.ocean.io/v2/enrich/person', {
  method: 'POST',
  headers: {
    'X-Api-Token': 'YOUR_API_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    person: { linkedin: 'linkedin.com/in/jane-doe-123' },
  }),
});
const data = await response.json();

To also reveal the email in the same request:

{
  "person": { "linkedin": "linkedin.com/in/jane-doe-123" },
  "revealEmails": {
    "includeEmails": true,
    "webhookUrl": "https://yourapp.com/webhooks/ocean"
  }
}

The base match response is returned synchronously. Email/phone results arrive at your webhook asynchronously.

Example response:

{
  "id": "abc123",
  "name": "Jane Doe",
  "jobTitle": "Head of Product",
  "seniorities": ["Head"],
  "departments": ["Product"],
  "domain": "example.com",
  "country": "de",
  "email": { "address": null, "status": "notFound" }
}