API keys
Company.info uses API keys to authenticate requests to the API Hub. An API key is a unique credential issued to a customer and must be included in every API request.
Provide the API key in the X-API-Key request header:
X-API-Key: your-api-key
The API validates the key before processing the request. Requests with a missing, invalid, or expired API key are rejected with an appropriate HTTP error response.
Customers are responsible for securely storing and managing their API keys and for ensuring that API usage complies with their agreement and the applicable terms and conditions.
Treat API keys as confidential credentials. Never expose them in client-side applications, public repositories, logs, or other publicly accessible locations.
Where to get?
During the onboarding process, you will choose a technical contact person. Once the onboarding process is complete, this person will receive an email containing the API key.
How to use?
To use the API key, include the API key in the header X-API-Key key as displayed in the example below.
curl -X GET 'https://api.company.info/example' \
-H 'accept: application/vnd.api+json' \
-H 'X-API-KEY: xxx'Possible issues
| Error Code | Error | Solution |
|---|---|---|
| 400 | Access to this API has been disallowed | The key probably doesn't contain the right policies or is expired. Please contact our support team. |
| 401 | Authorization Field Missing | Please verify if you provide the API key in the header properly |
| 403 | Key not authorized | Please verify that the API key is provided in the X-API-KEY request header and that the key is authorized to access this API. If the issue persists, please contact our support team. |