Some of our endpoints are asynchronous, meaning they will return immediately with a job ID while processing continues in the background. This is common for operations that may take longer to complete, such as bulk data processing or searches extraction.

​
How it works

There are two ways to handle asynchronous operations:

​
Polling Method

  1. Make a request to an async endpoint
  2. Receive a job ID in the response
  3. Periodically poll the status endpoint using the job ID
  4. Retrieve results once the job is complete

​
Webhook Method

  1. Make a request to an async endpoint with a webhook URL
  2. Receive a job ID in the response
  3. Continue your application flow
  4. Receive results automatically via webhook when job completes

In order to avoid unecessary load on our servers, we suggest using the webhook method.

​
Example Response

When you make a request to an async endpoint, you’ll receive a response like this:

{
  "enrichment_id": "550e8400-e29b-41d4-a716-446655440000"
}