Sign in

v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB
Enrich

Enrich person

Match a person with our database and enrich it with additional information.

Webhook result: Documentation

post/v2/enrich/person

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

Example request

{
  "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"
  }
}

Response

Successful Response

idstring required

Internal ocean id of the person

domainstring required

Domain of the company the person is working for

namestring nullable

Full name of the person

firstNamestring nullable

First name of the person

lastNamestring nullable

Last name of the person

countrystring nullable

Country code of the person

statestring nullable

State code of the person

locationstring nullable

Location of the person

linkedinUrlstring nullable

Link to the linkedin profile of the person

senioritiesSeniority[] nullable

List of seniorities computed from the job title of the person

departmentsDepartment[] nullable

List of departments computed from the job title of the person

photostring nullable

Link to the person's profile picture on LinkedIn

jobTitlestring nullable

Job title of the person

jobTitleEnglishstring nullable

English translation of the person's job title

currentJobDescriptionstring nullable

Current job description of the person

summarystring nullable

Summary of the person

skillsstring[] nullable

Skills of the person

inferredEmailsstring[]

List of inferred email addresses for the person. This is only available for enterprise subscriptions.

updatedAtstring nullable

When has the person data been updated for the last time

connectionsCountinteger nullable

Number of LinkedIn connections of the person

followersCountinteger nullable

Number of LinkedIn followers of the person

headlinestring nullable

Headline of the person

creditsUsednumber required

Number of credits charged for this request.

Example 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",
  "skills": [
    "Product Management",
    "Entrepreneurship",
    "Social Media"
  ],
  "phone": {
    "numbers": [
      "+4512345678",
      "+33 6 00 00 00 00"
    ]
  },
  "email": {
    "address": "name@gmail.com"
  },
  "inferredEmails": [
    "john.doe@domain.com",
    "j.doe@domain.com"
  ],
  "updatedAt": "2022-10-27T12:09:37Z",
  "connectionsCount": 10,
  "followersCount": 50,
  "headline": "Senior Software Engineer | Tech Lead",
  "creditsUsed": 0.1
}