Enrich person

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

Cost: 3 credits

Webhook result: Documentation

Request Body

application/jsonRequired

personRequiredPerson

The person to match with

companyobject | null | null

revealEmailsobject | null | null

revealPhonesobject | null | null

Query Parameters

apiTokenstring | null | null

Header Parameters

x-api-tokenstring | null | null

Response Body

Successful Response

TypeScript Definitions

Use the response body type in TypeScript.

idRequiredId

Internal ocean id of the person

domainRequiredDomain

Domain of the company the person is working for

namestring | null | null

firstNamestring | null | null

lastNamestring | null | null

countrystring | null | null

statestring | null | null

locationstring | null | null

linkedinUrlstring | null | null

senioritiesarray<unknown> | null | null

departmentsarray<unknown> | null | null

photostring | null | null

jobTitlestring | null | null

jobTitleEnglishstring | null | null

currentJobDescriptionstring | null | null

experiencesarray<unknown> | null | null

summarystring | null | null

skillsarray<unknown> | null | null

phoneobject | null | null

emailobject | null | null

Created

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "Data gathering process has started. Please try again later."

Bad Request

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "Conflicting API tokens provided in query parameters and headers" | "Empty `person` body"

Payment Required

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "Insufficient credits"

Forbidden

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "API token should be provided in headers or query parameters" | "Current API token is not registered in our database"

Not Found

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "No matching record found"

Validation Error

TypeScript Definitions

Use the response body type in TypeScript.

detailDetail

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": "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"
    }
  }'

const body = JSON.stringify({
  "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"
  }
})

fetch("https://api.ocean.io/v2/enrich/person?apiToken=string", {
  headers: {
    "x-api-token": "string"
  },
  body
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.ocean.io/v2/enrich/person?apiToken=string"
  body := strings.NewReader(`{
    "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"
    }
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("x-api-token", "string")
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.ocean.io/v2/enrich/person?apiToken=string"
body = {
  "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 = requests.request("POST", url, json = body, headers = {
  "x-api-token": "string",
  "Content-Type": "application/json"
})

print(response.text)

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