Skip to main content

API Overview

ClearBounce API reference documentation.

Base URL​

https://api.clearbounce.net/api/v1

Authentication​

All API requests require authentication via the X-API-Key header:

X-API-Key: cb_live_your_api_key_here

See Authentication for details.

Endpoints​

Single Verification​

MethodEndpointDescription
POST/verifyVerify a single email address

Bulk Verification​

MethodEndpointDescription
POST/bulk/uploadUpload emails for batch verification
GET/bulk/status/:jobIdGet job status and progress
GET/bulk/results/:jobIdDownload verification results

Account​

MethodEndpointDescription
GET/api-keysList your API keys
POST/api-keysCreate a new API key
PATCH/api-keys/:idUpdate an API key
DELETE/api-keys/:idDelete an API key

Request Format​

All POST requests must use JSON:

Content-Type: application/json

Response Format​

All responses are JSON:

{
"success": true,
"data": { ... },
"creditsRemaining": 999
}

Error Response​

{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Human readable message"
}
}

HTTP Status Codes​

CodeDescription
200Success
400Bad Request - Invalid input
401Unauthorized - Invalid or missing API key
402Payment Required - Insufficient credits
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error

Rate Limits​

See Integration Guidelines for rate limit details.

SDKs & Libraries​

Official SDKs coming soon:

  • Node.js
  • Python
  • PHP
  • Ruby
  • Go

In the meantime, use any HTTP client library with our REST API.