POST Requests: Clean Company API

Data type:

URLs:

Clean Company

https://api.coresignal.com/cdapi/v2/data_requests/company_clean/es_dsl https://api.coresignal.com/cdapi/v2/data_requests/company_clean/ids https://api.coresignal.com/cdapi/v2/data_requests/company_clean/shorthand_names https://api.coresignal.com/cdapi/v2/data_requests/company_clean/urls

---

Overview

Bulk Collect features three POST endpoints, making collecting company data records in bulk easier.

Before you proceed with your Bulk Collect requests, test them in the Clean Company API first to avoid any unexpected costs.

Find step-by-step guides for making Bulk Collect POST requests in the following topic:

Bulk Collect POST requests guides

Elasticsearch DSL requests

Use the endpoint /v2/data_requests/company_clean/es_dsl to request company data in bulk using our Elasticsearch DSL schema:

Clean Company API Elasticsearch DSL schema

Endpoint usage example

Example request

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/data_requests/company_clean/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "limit": {optional_integer},
  "webhook_url": "{optional_webhook_url}",
  "es_dsl_query": '{
   "query":{
      "bool":{
         "must":[
            {
               "query_string":{
                  "query":"2023",
                  "default_field":"founded",
                  "default_operator":"and"
               }
            }
         ]
      }
   }
}'

• Retrieve the request ID from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

IDs requests

Use the endpoint /v2/data_requests/company_clean/ids to submit a list of IDs to request company data in bulk.

Endpoint usage example

cURL request

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/company_clean/ids' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -d '{
  "limit": {optional_integer},
  "webhook_url": "{optional_webhook_url}",
  "ids": [
    1,
    222,
    3456
  ]
}'

• Retrieve the request_id from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

Shorthand names and URLs requests

You can send up to 10,000 shorthand_names or URLs per request. Requirements for shorthand_names are listed below:

Shorthand names requirements

Endpoint usage example

shorthand_names

Example request for shorthand_names

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/company_clean/shorthand_names' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{optional_webhook_url}",
   "shorthand_names": ": [
      "example-company",
      "company1",
      "example-corp"
      ]
   }'

URLs

• Retrieve the request ID from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

Following steps

Make GET requests to download the data