Quickstart

CompanyEnrich API is a REST based API accepting and returning JSON documents. Authentication requires obtaining an access token from Dashboard.

Authentication

The API token should be provided in an Authroization header as a Basic authentication token as follows:

GET /companies/enrich
Authroization: Basic <YOURTOKEN>

All endpoints accept the same access token structure.

📘

Please do not share, publish or commit your API tokens to public source code repositories. The tokens should be kept secret

Errors

The CompanyEnrich API uses standard HTTP response codes to signal the success or failure of an API request:

• Codes in the 2xx range indicate the request was successful.
• Codes in the 4xx range indicate there was an error in the request, such as a missing required parameter.
• Codes in the 5xx range indicate an error occurred on CompanyEnrich's servers (this is uncommon).

Some 4xx errors include an error code that concisely explains what went wrong, allowing the error to be handled programmatically by the client application.

Please refer to each individual API endpoint for further details about the errors generated.