LogoOcean.io
API/Endpoints/Enrich

Enrich person

Match a person with our database and enrich it with additional information. **Cost: 3 credits**

POST
/v2/enrich/person

Request Body

application/jsonRequired
personRequiredPerson

The person to match with

companyCompany

The company to match the person with

revealEmailsReveal emails
revealPhonesReveal phones

Query Parameters

apiTokenRequiredApitoken
curl -X POST "https://api.ocean.io/v2/enrich/person?apiToken=string" \
  -H "Content-Type: application/json" \
  -d '{
    "person": {
      "id": "b8952796be57982d",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "jobTitle": "CEO",
      "email": "john.doe@example.com",
      "phone": "+45 12345678",
      "facebook": "https://www.facebook.com/johndoe",
      "twitter": "https://twitter.com/johndoe",
      "linkedin": "https://www.linkedin.com/in/johndoe",
      "country": "dk"
    },
    "company": {
      "name": "Ocean ApS",
      "registrationNumber": "123456789",
      "email": "hello@ocean.io",
      "phone": "+45 12345678",
      "countryCode": "dk",
      "state": "Arkansas",
      "city": "Copenhagen",
      "streetAddress": "Strandgade 6",
      "postalCode": "1401",
      "address": "Strandgade 6, 1401 Copenhagen",
      "facebook": "https://www.facebook.com/oceanio",
      "twitter": "https://twitter.com/oceanio",
      "linkedin": "https://www.linkedin.com/company/oceanio",
      "instagram": "https://www.instagram.com/oceanio",
      "xing": "https://www.xing.com/oceanio",
      "domain": "ocean.io",
      "youtube": "https://www.youtube.com/oceanio"
    },
    "revealEmails": {
      "includeEmails": true,
      "webhookUrl": "https://url.com/webhook"
    },
    "revealPhones": {
      "includePhones": true,
      "webhookUrl": "https://url.com/webhook"
    }
  }'

Successful Response

{
  "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",
  "phone": {
    "numbers": [
      "+4512345678",
      "+33 6 00 00 00 00"
    ],
    "status": "verified"
  },
  "email": {
    "address": "example.jonas@ocean.io",
    "status": "verified"
  }
}