Authentification and API keys

What is an API key?

An API key is your unique identifier used to authenticate requests to an API. It's a string of 32 characters (letters and numbers) that tells the API:

  • Who is making the request

  • Whether they're allowed to do what they're asking

  • How much they've used the service

Can I have multiple API keys?

Yes, you can generate and manage multiple API keys. Go to the API keys section in your account settings. In this section, you will see all of the API keys associated with your account and will have the option to regenerate or delete them.


How API keys work

1. You get an API key

Go to Coresignal's self-service platform and copy the API key in the Authentification section on the platform's homepage.

Go to self-service

2. You include the key in your API requests

You send the key as part of your HTTP request using Swagger UI, Postman, or other preferred service. An authorization request header will be used for API Key authorization, listed under apikey.

Endpoints

You will need to know the precise endpoint for each dataset (e.g. if you want to access Base Company Data, you will need to add the relevant endpoint into this request).

You can find a full list of all available endpoints on the self-service platform.

3. The API server checks your key

The server looks up the key to:

  • See if it's valid

  • Check your permissions

  • Enforce any rate limits (e.g., 1000 requests/day)

If everything checks out, the server processes your request and returns the data or response.


Why use API keys?

  • Authentication: To identify the user or app calling the API

  • Rate limiting: To prevent abuse and control usage

  • Analytics: To track how APIs are being used

  • Access control: To limit access to specific features, data, or environments

Last updated

Was this helpful?