Authorization

Authorization key

To start using our API, you need an API Key. You can get the API Key from Coresignal's self-service platform. Moreover, your account manager or sales representative can generate the key for you upon your request for the API plan.

Authorization header

All requests must contain an API Key header. Its value is your unique API Key.

Authorization header

-H “apikey: {API Key}”

cURL authorization

Several examples of authorization in cURL are given according to the required request. Here, requests are made using Base Company API endpoints.

Elasticsearch DSL

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/company_base/search/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   //insert your query
}'

General authorization templates

Templates for authentication in various programming languages and programming environment.

import requests

api_endpoint = "API_ENDPOINT"
api_key = {API Key}

headers = {
    "apikey": api_key
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)

require 'net/http'
require 'uri'

uri = URI.parse("API_ENDPOINT")
http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Get.new(uri.request_uri)
api_key = {API Key}
request['apikey'] = api_key

response = http.request(request)
puts response.body

const https = require('https');

const apiEndpoint = 'API_ENDPOINT';
const apiKey = {API Key};

const options = {
    headers: {
        'apikey': apiKey
    }
};

https.get(apiEndpoint, options, (response) => {
    let data = '';
    response.on('data', (chunk) => {
        data += chunk;
    });

    response.on('end', () => {
        console.log(data);
    });
});

<?php
$apiEndpoint = "API_ENDPOINT";
$apiKey = {API Key};

$options = [
    'http' => [
        'header' => "apikey: $apiKey"
    ]
];

$context = stream_context_create($options);
$response = file_get_contents($apiEndpoint, false, $context);
?>

Use any API-compatible tool to authorize and start querying the API.

FAQ

Where can I find my API Key?

API Key is stored in the self-service platform home page's Authentication section.

How do I use API Key?

If you've previously used a JWT token, you need to change it to an API Key.
Change your authorization request header's to API Key: -H 'apikey: {API Key}' Here, insert your API Key instead of {API Key}
Make sure that you are using the correct endpoints. API Key is compatible with v2 endpoints. For example: /v2/company_base/search/es_dslNote: several enrichment endpoints do not have v2, but still work with API Key.

PreviousAPIs Overview NextCredits

Last updated 4 months ago

Was this helpful?