How to authenticate with the Beauhurst APIs
To access the Beauhurst APIs, you will need to authenticate your requests using API keys. The API keys are unique identifiers assigned to your subscription and are used to authorise access to the APIs.
Find your API keys
If you have included access to any of the Beauhurst APIs in your subscription then you can find your API keys in your Subscription Settings on the platform.
If you don't have access to the APIs then contact your Account Manager who can get you set up.
Authenticating requests
The Company news API key is needed to authenticate the Company news API, the API key authenticates all other APIs and endpoints.
To authenticate your requests you will need to use the relevant API key as a parameter in the request header named Authorization. For example:
curl -X 'GET' \
'https://platform.beauhurst.com/_api/v1/companies/
-H 'accept: application/json' \
-H 'Authorization: apikey BeauhurstAPIKey'
You will need to replace BeauhurstAPIKey with your own API key.
Securing your API key
Keep your API key secure and never share it with unauthorised users or applications. We monitor API usage to identify and prevent any suspicious activity or unauthorised access attempts.
If you require a new API key contact your Account Manager who can create one for you.