Skip to main content

Base URL

All API requests should be made to:

Request Headers

Include these headers with every request:

Response Format

All responses are returned in JSON format with a consistent structure:

Successful Response

Error Response

Every error carries success: false and a stable error code. Switch on error, not on message — the code is part of the contract, the sentence is not and may be reworded.

HTTP Status Codes

409 is common and is not a failure. We deduplicate per domain: if the same domain is already being enriched, or was enriched in the last 24 hours, you get a 409 rather than a second charge. Treat it as “ask the main endpoint again” — see recently_enriched below.

Error Codes

company_not_found is not returned for an unknown domain — the API enriches it instead and answers 202. You will only see it if a company was deleted between queuing a batch and fetching its results.

Error Handling Example

Note: When a domain requires enrichment, the API returns 202 Accepted and starts enrichment automatically. Handle this by checking for status === 202 and the batch_id in the response. Results will be delivered to your webhook.