Enrich company

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

Cost calculation:

request contains company domain - 1 credit
request does not contain company domain - 5 credits

Webhook result: Documentation

Request Body

application/jsonRequired

companyCompany

The company to match with

peoplePeople

The people to match company with

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.

domainRequiredDomain

Domain of the company, used as a unique identifier

countriesarray<unknown> | null | null

primaryCountrystring | null | null

companySizestring | null | null

Value in:

"0-1" | "2-10" | "11-50" | "51-200" | "201-500" | "501-1000" | "1001-5000" | "5001-10000" | "10001-50000" | "50001-100000" | "100001-500000" | "500000+"

industryCategoriesarray<unknown> | null | null

industriesarray<unknown> | null | null

linkedinIndustrystring | null | null

ecommerceboolean | null | null

keywordsarray<unknown> | null | null

employeeCountOceaninteger | null | null

employeeCountLinkedininteger | null | null

revenuestring | null | null

Value in: "0-1M" | "1-10M" | "10-50M" | "50-100M" | "100-500M" | "500-1000M" | ">1000M"

yearFoundedinteger | null | null

descriptionstring | null | null

emailsarray<unknown> | null | null

phonesarray<unknown> | null | null

logostring | null | null

technologiesarray<unknown> | null | null

technologyCategoriesarray<unknown> | null | null

mobileAppsarray<unknown> | null | null

webTrafficobject | null | null

mediasobject | null | null

namestring | null | null

legalNamestring | null | null

locationsarray<unknown> | null | null

departmentSizesarray<unknown> | null | null

rootUrlstring | null | null

faxesarray<unknown> | null | null

impressumobject | null | null

fundingRoundobject | null | null

headcountGrowthobject | null | null

headcountGrowthPerDepartmentarray<unknown> | 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 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

Validation Error

TypeScript Definitions

Use the response body type in TypeScript.

detailDetail

curl -X POST "https://api.ocean.io/v2/enrich/company?apiToken=string" \
  -H "x-api-token: string" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
    },
    "people": [
      {
        "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"
      }
    ]
  }'

const body = JSON.stringify({
  "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"
  },
  "people": [
    {
      "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"
    }
  ]
})

fetch("https://api.ocean.io/v2/enrich/company?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/company?apiToken=string"
  body := strings.NewReader(`{
    "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"
    },
    "people": [
      {
        "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"
      }
    ]
  }`)
  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/company?apiToken=string"
body = {
  "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"
  },
  "people": [
    {
      "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"
    }
  ]
}
response = requests.request("POST", url, json = body, headers = {
  "x-api-token": "string",
  "Content-Type": "application/json"
})

print(response.text)

{
  "domain": "dundermifflinpaper.com",
  "countries": [
    "us",
    "ca"
  ],
  "primaryCountry": "us",
  "companySize": "2-10",
  "industryCategories": [
    "Consumer Electronics",
    "Hardware"
  ],
  "industries": [
    "Audio",
    "Electronics"
  ],
  "linkedinIndustry": "Computer Software",
  "ecommerce": true,
  "keywords": [
    "paper",
    "premium copy paper"
  ],
  "employeeCountOcean": 57,
  "employeeCountLinkedin": 70,
  "revenue": "1-10M",
  "yearFounded": 1999,
  "description": "Dunder Mifflin Paper Company, Inc. is a fictional paper and office supplies wholesale company featured in the American television series The Office.",
  "emails": [
    "email1@domain.com",
    "email2@domain.com"
  ],
  "phones": [
    {
      "country": "us",
      "number": "+1 212 456 7890",
      "primary": true
    },
    {
      "country": "ca",
      "number": "+1 250 555 0199"
    }
  ],
  "logo": "https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png",
  "technologies": [
    "Accesso",
    "Adcash",
    "Atlassian Jira"
  ],
  "technologyCategories": [
    "Security",
    "Analytics",
    "Blogs"
  ],
  "mobileApps": [
    {
      "link": "https://www.my.app.com/",
      "name": "My awesome app"
    }
  ],
  "webTraffic": {
    "bounceRate": 0.5227,
    "pageViews": 2155984,
    "pagesPerVisit": 4.88,
    "visits": 10000
  },
  "medias": {
    "linkedin": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://www.linkedin.com/company/dunder-mifflin"
    },
    "twitter": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://twitter.com/dunder-mifflin"
    },
    "youtube": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://youtube.com/channel/dunder-mifflin"
    },
    "facebook": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://facebook.com/dunder-mifflin"
    },
    "xing": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://xing.com/dunder-mifflin"
    },
    "tiktok": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://tiktok.com/dunder-mifflin"
    },
    "instagram": {
      "handle": "dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "url": "https://instagram.com/dunder-mifflin"
    }
  },
  "name": "Dunder Mifflin Paper Company",
  "legalName": "Dunder Mifflin Paper Company, Inc.",
  "locations": [
    {
      "primary": true,
      "latitude": 43.6471,
      "longitude": -79.3971,
      "country": "us",
      "locality": "Scranton",
      "region": "Lackawanna County",
      "postalCode": "18505",
      "streetAddress": "Scranton Business Park, 1725 Slough Ave Suit 200",
      "state": "pa",
      "regionCode": "PA"
    }
  ],
  "departmentSizes": [
    {
      "department": "Accounting and Finance",
      "size": 10
    },
    {
      "department": "Sales",
      "size": 15
    }
  ],
  "rootUrl": "https://dundermifflinpaper.com/",
  "faxes": [
    {
      "country": "us",
      "number": "5709045026",
      "primary": true
    }
  ],
  "impressum": {
    "company": "Dunder Mifflin Paper Company, Inc.",
    "address": "Scranton Business Park, 1725 Slough Ave Suit 200, Scranton, USA",
    "email": "email@dundermifflin.com",
    "phone": "+35123456789",
    "fax": "+35123456790",
    "vat": "123456",
    "url": "https://dundermifflinpaper.com/impressum",
    "people": [
      {
        "name": "Michael Scott",
        "position": "Regional Manager"
      }
    ]
  },
  "fundingRound": {
    "cbUrl": "https://www.crunchbase.com/funding_round/orderyoyo-post-ipo-equity--5c26b0c0",
    "date": "2020-01-01",
    "moneyRaisedInUsd": 1000000,
    "type": "Seed"
  },
  "headcountGrowth": {
    "sixMonths": 20,
    "threeMonths": 10,
    "twelveMonths": 30
  },
  "headcountGrowthPerDepartment": [
    {
      "department": "Accounting and Finance",
      "growth": {
        "sixMonths": 20,
        "threeMonths": 10,
        "twelveMonths": 30
      }
    }
  ]
}

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

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}