Skip to main content
GET
/
v1.1
/
email
/
verify
/
batch
/
{batchId}
Check status
curl --request GET \
  --url https://api.usebouncer.com/v1.1/email/verify/batch/{batchId} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.usebouncer.com/v1.1/email/verify/batch/{batchId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.usebouncer.com/v1.1/email/verify/batch/{batchId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usebouncer.com/v1.1/email/verify/batch/{batchId}",
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;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.usebouncer.com/v1.1/email/verify/batch/{batchId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.usebouncer.com/v1.1/email/verify/batch/{batchId}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.usebouncer.com/v1.1/email/verify/batch/{batchId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "batchId": "4d5fdf6b5ee97c4dbbccbfe1",
  "created": "2023-03-26T15:27:26.713Z",
  "started": "2023-03-26T15:27:30.124Z",
  "status": "processing",
  "quantity": 2,
  "duplicates": 0
}
Field “credits” will be filled with number of credits used once batch is complete. Additional query parameter “with-stats=true” will add to the response processing progress and statistics.

{
    "batchId": "642152127eec9c46c00fb8d7",
    "created": "2023-03-27T08:21:38.357Z",
    "started": "2023-03-27T08:21:40.355Z",
    "completed": "2023-03-27T08:21:51.426Z",
    "status": "completed",
    "quantity": 2,
    "duplicates": 0,
    "credits": 2,
    "processed": 2,
    "stats": {
        "deliverable": 1,
        "risky": 0,
        "undeliverable": 1,
        "unknown": 0
    }
}


Authorizations

x-api-key
string
header
required

Path Parameters

batchId
string
required

batchId from create response

Query Parameters

with-stats
boolean
default:false

collect additional processing statistics

Response

OK

The response is of type object.