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
| Method | Endpoint | Description |
|---|---|---|
| POST | /verify | Verify a single email address |
Bulk Verification
| Method | Endpoint | Description |
|---|---|---|
| POST | /bulk/upload | Upload emails for batch verification |
| GET | /bulk/status/:jobId | Get job status and progress |
| GET | /bulk/results/:jobId | Download verification results |
Account
| Method | Endpoint | Description |
|---|---|---|
| GET | /api-keys | List your API keys |
| POST | /api-keys | Create a new API key |
| PATCH | /api-keys/:id | Update an API key |
| DELETE | /api-keys/:id | Delete 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
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request - Invalid input |
| 401 | Unauthorized - Invalid or missing API key |
| 402 | Payment Required - Insufficient credits |
| 404 | Not Found - Resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal 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.