Documentation

Errors & Timeouts

Common API error codes, timeout recommendations, and backward compatibility guarantees.

Timeouts and API Response Time

While some requests complete within a few seconds, some can take many, typically when fresh data has to be fetched from the source.

You are encouraged to make concurrent requests to our API service to maximize throughput.

We recommend timeouts of 90 seconds for v2 endpoints and 300 seconds for v3 endpoints.

Errors

These are the common errors that could be returned by our API:

HTTP CodeCharge?Description
400NoInvalid parameters provided. Refer to the documentation and message body for more info.
401NoInvalid API Key
403NoYou have run out of credits
404NoThe requested resource (e.g: user profile, company) could not be found.
410NoThis API is deprecated
429NoRate limited. Please retry. See Rate Limits
500NoThere is an error with our API. Please contact us for assistance
503NoEnrichment failed, please retry.

You will never be charged for errors that represent failure.

Backward Compatibility Guarantee

We are committed to ensuring that our API remains backward compatible, allowing you to integrate with confidence. Our backward compatibility guarantee means that we will not introduce changes that break existing functionality or remove endpoints without a deprecation period.

To be specific, we will not introduce breaking changes in the following ways:

  1. We will not remove documented parameters and response attributes.
  2. We will not change the data type as documented in our API responses.

However, the following are not considered breaking changes:

  • Adding attributes/parameters to API endpoints without prior notice.
  • Adding additional response or requests headers to our API endpoints without prior notice.

We highly recommend you integrate our API in a way that would not break should new response attributes or headers be introduced.

If we make changes to our API, we will provide clear documentation and sufficient notice (30 days) to ensure a seamless transition. Notices will be shared via newsletter emails, Twitter/X posts and updates to our blog.