v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Enrich

Enrich company

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

Webhook result: Documentation

post/v2/enrich/company

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

fieldsCompanyField[] nullable

Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.

Example request

{
  "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"
    }
  ],
  "fields": [
    "domain",
    "countries",
    "primaryCountry",
    "companySize",
    "industryCategories",
    "industries",
    "linkedinIndustry",
    "ecommerce",
    "keywords",
    "employeeCountOcean",
    "employeeCountLinkedin",
    "revenue",
    "yearFounded",
    "description",
    "emails",
    "phones",
    "logo",
    "technologies",
    "technologyCategories",
    "mobileApps",
    "webTraffic",
    "medias",
    "name",
    "legalName",
    "locations",
    "departmentSizes",
    "rootUrl",
    "faxes",
    "impressum",
    "fundingRound",
    "updatedAt"
  ]
}

Response

Successful Response

domainstring required

Domain of the company, used as a unique identifier

countriesstring[] nullable

List of all countries in which the company operates

primaryCountrystring nullable

Main country of the company

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

industryCategoriesstring[] nullable

Industry categories of the company<br>Available values can be found at /v2/data-fields endpoint.

industriesstring[] nullable

Industries of the company<br>Available values can be found at /v2/data-fields endpoint.

linkedinIndustrystring nullable

Linkedin industry of the company<br>Available values can be found at /v2/data-fields endpoint.

ecommerceboolean nullable

True if the company is an e-commerce company

keywordsstring[] nullable

Keywords associated with the company

employeeCountOceaninteger nullable

Number of people working at the company in our database.

employeeCountLinkedininteger nullable

Number of people linked to the company page on Linkedin. This number might be higher than employeeCountOcean because of private profiles.

revenue'0-1M' | '1-10M' | '10-50M' | '50-100M' | '100-500M' | '500-1000M' | '>1000M'

yearFoundedinteger nullable

Year the company was founded

descriptionstring nullable

Company's description

emailsstring[] nullable

Emails of the company

logostring nullable

Logo of the company (URL)

technologiesstring[] nullable

Software technologies used by the company

technologyCategoriesstring[] nullable

Technology categories of the company

namestring nullable

Name of the company

legalNamestring nullable

Legal name of the company

rootUrlstring nullable

Root url to access the website

redirectedFromstring[] nullable

Urls that redirects to this domain. We provide maximum 10 urls in this field.

updatedAtstring nullable

When has the company data been updated for the last time

creditsUsednumber required

Number of credits charged for this request.

Example response

{
  "domain": "dundermifflinpaper.com",
  "countries": [
    "us",
    "ca"
  ],
  "primaryCountry": "us",
  "industryCategories": [
    "Consumer Electronics",
    "Hardware"
  ],
  "industries": [
    "Audio",
    "Electronics"
  ],
  "linkedinIndustry": "Computer Software",
  "ecommerce": true,
  "keywords": [
    "paper",
    "premium copy paper"
  ],
  "employeeCountOcean": 57,
  "employeeCountLinkedin": 70,
  "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"
    }
  ],
  "medias": {
    "linkedin": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    },
    "twitter": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    },
    "youtube": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    },
    "facebook": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    },
    "xing": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    },
    "tiktok": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    },
    "instagram": {
      "specialties": [
        "artificial intelligence",
        "machine learning"
      ]
    }
  },
  "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"
      }
    ]
  },
  "redirectedFrom": [
    "pol.dk",
    "pressen.nu"
  ],
  "updatedAt": "2022-08-22T12:09:37Z",
  "headcountGrowthPerDepartment": [
    {
      "department": "Accounting and Finance",
      "growth": {
        "sixMonths": 10,
        "sixMonthsPercentage": 0.2,
        "threeMonths": 5,
        "threeMonthsPercentage": 0.1,
        "twelveMonths": 15,
        "twelveMonthsPercentage": 0.3
      }
    }
  ],
  "creditsUsed": 0.1
}