Reveal emails

Webhook result: Documentation

Quickstart#

Person IDs come from the id field in Search People or Enrich Person responses.

curl -X POST "https://api.ocean.io/v2/reveal/emails" \
  -H "X-Api-Token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "personIds": ["abc123", "def456", "ghi789"],
    "webhookUrl": "https://yourapp.com/webhooks/ocean-emails"
  }'

import requests

response = requests.post(
    'https://api.ocean.io/v2/reveal/emails',
    headers={'X-Api-Token': 'YOUR_API_TOKEN'},
    json={
        'personIds': ['abc123', 'def456', 'ghi789'],
        'webhookUrl': 'https://yourapp.com/webhooks/ocean-emails',
    },
)
data = response.json()  # {"status": "in progress"} — results arrive at your webhook

const response = await fetch('https://api.ocean.io/v2/reveal/emails', {
  method: 'POST',
  headers: { 'X-Api-Token': 'YOUR_API_TOKEN', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    personIds: ['abc123', 'def456', 'ghi789'],
    webhookUrl: 'https://yourapp.com/webhooks/ocean-emails',
  }),
});
const data = await response.json(); // {"status": "in progress"} — results arrive at your webhook

Immediate response:

{ "status": "in progress" }

Webhook payload:

{
  "results": [
    { "personId": "abc123", "email": { "address": "[email protected]", "status": "verified" } },
    { "personId": "def456", "email": { "address": "[email protected]", "status": "guessed" } },
    { "personId": "ghi789", "email": { "address": null, "status": "notFound" } }
  ]
}