API Playground
Check enrichment status
Poll a batch while it runs. Free — polling never costs credits.
Prefer the webhook: it tells you the moment the batch lands. Polling is the fallback when you cannot receive one.
GET
/
enrichment
/
{batch_id}
/
status
Check enrichment status
curl --request GET \
--url https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"success": true,
"batch_id": "batch_1gVwXby8PsYHoMQR",
"domain": "stripe.com",
"status": "processing",
"requested_modules": [
"business",
"technology"
],
"message": "<string>",
"credits": {
"reserved": 20,
"used": 0,
"refunded": 0
},
"timing": {
"requested_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"duration_seconds": 123
},
"webhook": {
"url": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"retries": 0
},
"results_endpoint": "<string>"
}{
"success": false,
"error": "missing_api_key",
"message": "Please provide your API key in X-API-Key header or api_key parameter"
}{
"success": false,
"error": "webhook_required",
"message": "Webhook URL is required for enrichment requests",
"hint": "<string>",
"documentation": "<string>"
}{
"success": false,
"error": "webhook_required",
"message": "Webhook URL is required for enrichment requests",
"hint": "<string>",
"documentation": "<string>"
}{
"success": false,
"error": "rate_limit_exceeded",
"message": "Rate limit exceeded. Please retry after 45 seconds.",
"retry_after": 45,
"limits": {
"per_minute": 150,
"per_day": 5000,
"current_minute": 150,
"current_day": 3204
}
}Path Parameters
The batch_id returned by the 202.
Example:
"batch_1gVwXby8PsYHoMQR"
Response
Current state of the batch.
Example:
true
Example:
"batch_1gVwXby8PsYHoMQR"
Example:
"stripe.com"
Available options:
queued, processing, completed, failed, no_data_found Example:
"processing"
Example:
["business", "technology"]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
null until the batch completes.
⌘I
Check enrichment status
curl --request GET \
--url https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bouncewatch.com/api/v1/enrichment/{batch_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"success": true,
"batch_id": "batch_1gVwXby8PsYHoMQR",
"domain": "stripe.com",
"status": "processing",
"requested_modules": [
"business",
"technology"
],
"message": "<string>",
"credits": {
"reserved": 20,
"used": 0,
"refunded": 0
},
"timing": {
"requested_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"duration_seconds": 123
},
"webhook": {
"url": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"status": "<string>",
"retries": 0
},
"results_endpoint": "<string>"
}{
"success": false,
"error": "missing_api_key",
"message": "Please provide your API key in X-API-Key header or api_key parameter"
}{
"success": false,
"error": "webhook_required",
"message": "Webhook URL is required for enrichment requests",
"hint": "<string>",
"documentation": "<string>"
}{
"success": false,
"error": "webhook_required",
"message": "Webhook URL is required for enrichment requests",
"hint": "<string>",
"documentation": "<string>"
}{
"success": false,
"error": "rate_limit_exceeded",
"message": "Rate limit exceeded. Please retry after 45 seconds.",
"retry_after": 45,
"limits": {
"per_minute": 150,
"per_day": 5000,
"current_minute": 150,
"current_day": 3204
}
}
