Enrich company

POST /v2/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
application/json

Body Required

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • domain string Required

      Domain of the company, used as a unique identifier

    • countries array[string] | null
    • primaryCountry string | null
    • companySize string | null

      Values are 0-1, 2-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001-50000, 50001-100000, 100001-500000, or 500000+.

    • industryCategories array[string] | null
    • industries array[string] | null
    • ecommerce boolean | null
    • keywords array[string] | null
    • employeeCountOcean integer | null
    • revenue string | null

      Values are 0-1M, 1-10M, 10-50M, 50-100M, 100-500M, 500-1000M, or >1000M.

    • yearFounded integer | null
    • description string | null
    • emails array[string] | null
    • phones array[object] | null
      Hide phones attributes Show phones attributes object
      • number string Required

        Contact number

      • country string | null
      • primary boolean

        True if the contact number is the primary contact number of the company

    • technologies array[string] | null
    • technologyCategories array[string] | null
    • mobileApps array[object] | null
      Hide mobileApps attributes Show mobileApps attributes object
    • webTraffic object | null

      Additional properties are allowed.

      Hide webTraffic attributes Show webTraffic attributes object | null
    • medias object | null

      Additional properties are allowed.

      Hide medias attributes Show medias attributes object | null
      • linkedin object | null

        Additional properties are allowed.

        Hide linkedin attributes Show linkedin attributes object | null
      • twitter object | null

        Additional properties are allowed.

        Hide twitter attributes Show twitter attributes object | null
      • youtube object | null

        Additional properties are allowed.

        Hide youtube attributes Show youtube attributes object | null
      • facebook object | null

        Additional properties are allowed.

        Hide facebook attributes Show facebook attributes object | null
      • xing object | null

        Additional properties are allowed.

        Hide xing attributes Show xing attributes object | null
      • tiktok object | null

        Additional properties are allowed.

        Hide tiktok attributes Show tiktok attributes object | null
      • instagram object | null

        Additional properties are allowed.

        Hide instagram attributes Show instagram attributes object | null
    • name string | null
    • legalName string | null
    • locations array[object] | null
      Hide locations attributes Show locations attributes object
    • departmentSizes array[object] | null
      Hide departmentSizes attributes Show departmentSizes attributes object
      • department string Required

        Values are Accounting and Finance, Board, Business Support, Customer Relations, Design, Editorial Personnel, Engineering, Founder/Owner, Healthcare, HR, Legal, Management, Manufacturing, Marketing and Advertising, Operations, PR and Communications, Procurement, Product, Quality Control, R&D, Sales, Security, Supply Chain, or Other.

      • size integer Required

        Department size

    • rootUrl string | null
    • faxes array[object] | null
      Hide faxes attributes Show faxes attributes object
      • number string Required

        Contact number

      • country string | null
      • primary boolean

        True if the contact number is the primary contact number of the company

    • impressum object | null

      Additional properties are allowed.

      Hide impressum attributes Show impressum attributes object | null
  • Not found

  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
POST /v2/enrich/company
curl \
 -X POST https://api.ocean.io/v2/enrich/company?apiToken=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"}]}'
Request examples
{
  "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 examples (200)
{
  "domain": "dundermifflinpaper.com",
  "countries": [
    "us",
    "ca"
  ],
  "primaryCountry": "us",
  "companySize": "2-10",
  "industryCategories": [
    "Consumer Electronics",
    "Hardware"
  ],
  "industries": [
    "Audio",
    "Electronics"
  ],
  "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": [
    {
      "number": "+1 212 456 7890",
      "country": "us",
      "primary": true
    },
    {
      "number": "+1 250 555 0199",
      "country": "ca"
    }
  ],
  "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": {
    "visits": 10000,
    "pageViews": 2155984,
    "bounceRate": 0.5227,
    "pagesPerVisit": 4.88
  },
  "medias": {
    "linkedin": {
      "url": "https://www.linkedin.com/company/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "dunder-mifflin"
    },
    "twitter": {
      "url": "https://twitter.com/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "dunder-mifflin"
    },
    "youtube": {
      "url": "https://youtube.com/channel/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "dunder-mifflin"
    },
    "facebook": {
      "url": "https://facebook.com/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "dunder-mifflin"
    },
    "xing": {
      "url": "https://xing.com/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "dunder-mifflin"
    },
    "tiktok": {
      "url": "https://tiktok.com/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "dunder-mifflin"
    },
    "instagram": {
      "url": "https://instagram.com/dunder-mifflin",
      "name": "Dunder Mifflin Paper Company, Inc.",
      "handle": "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": [
    {
      "size": 10,
      "department": "Accounting and Finance"
    },
    {
      "size": 15,
      "department": "Sales"
    }
  ],
  "rootUrl": "https://dundermifflinpaper.com/",
  "faxes": [
    {
      "number": "5709045026",
      "country": "us",
      "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"
      }
    ]
  }
}
Response examples (422)
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}