Enrich companies

Match companies with our database and enrich it with additional information.

Webhook result: Documentation

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

companyDataMapping*

A dictionary where each key is unique user-defined ID for a company, and each value is the data for that company to be enriched. This ID will be included in the webhook response together with the enriched company data, allowing the user to match the response to the original request.

Properties1 <= properties <= 10000

webhookUrl*string

Url of the webhook the enriched companies should be sent to, when completed.

Example"https://some-url.com"

fields?array<>

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

["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 Body

`application/json`

curl -X POST "https://api.ocean.io/v2/enrich/companies" \  -H "Content-Type: application/json" \  -d '{    "companyDataMapping": {      "property1": {},      "property2": {}    },    "webhookUrl": "https://some-url.com"  }'

{
  "status": "in progress"
}

{
  "detail": "Conflicting API tokens provided in query parameters and headers"
}

{
  "detail": "Insufficient email credits"
}

{
  "detail": "API token should be provided in headers or query parameters"
}

Empty

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

Enrich companies

Query Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Enrich companies

Query Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

402application/json

403application/json

404

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`