Company API

Response Codes

16min

Company API endpoint response codes

Explore the variety of possible response codes and what they mean in the Company API.

These error codes can be encountered in all Company API endpoints, such as:

  • Search and collect endpoints
  • Bulk Collect.

A successful query will return the 200 code. An unsuccessful query will return any of the following error codes.

Error code

Description

400

Request was unacceptable, often due to a missing required parameter. Error message differs based on the error.

Several examples



Error code

Description

401

No valid API bearer token {JWT} was provided. Check if your token is valid and try again.

404

  • Nonexistent API URL: Using DBAPI instead of CDAPI in the API URL while making a request will result in a 404 error message.
  • Nonexistent ID: Using a profile ID that does not exist in our database, you will receive the following response:
Nonexistent API URL
Noneexistant ID



Error code

Description

422

Incorrect data structure or data types provided in the request.

422
Duplicate keys



Error code

Description

429

Endpoint rate limit has been exceeded.

Company API endpoints restrict the number of requests allowed per second for each client's API token.

Company API search endpoints

Company API collection endpoints

Bulk Collect POST endpoints

Bulk Collect GET endpoints

Allow 18 requests per second.

Allow 54 requests per second.

Allow 27 requests per second.

Allow 27 requests per second.



Error code

Description

5xx

One possible example is that the wrong request type was selected (POST/GET).

Code denotes server issues.

502



Code

Explanation

503

Service is unavailable due to too many requests received by our API.

503



Bulk Collect response codes

The following codes are specific to the Bulk Collect endpoints.

Error code

Description

400

Indicates incorrectly formatted or oversized files or invalid data:

Several examples


Error code

Description

402

Insufficient credits. Reduce your request size or contact your account manager to get more credits.

Insufficient credits


Error code

Description

409

Duplicate POST requests were submitted.

409


Error code

Explanation

503

Bulk Collect allows you to download the prepared dataset as often as you like within 30 days of submitting the query.

After 30 days of query submission, the GET query will return a 503 response code with the following message:

503




Updated 29 Oct 2024
Did this page help you?