HeroBounce

API Documentation & Testing

Test the API and view integration examples in different languages.

Your API Keys

Manage your API keys for authentication

Create and manage your API keys from the dedicated API Keys page. Each key can be named for easy identification.

API Tester

Test the validation API with a sample email

Code Examples

Integration examples in different programming languages

# Single email validation (POST method)
curl -X POST "https://herobounce.com/api/v1/validation/single" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"email": "test@example.com"}'

# Single email validation (GET method - simpler!)
curl -X GET "https://herobounce.com/api/v1/validation/single?email=test@example.com" \
  -H "X-API-Key: your_api_key_here"

# Bulk validation (up to 1000 emails)
curl -X POST "https://herobounce.com/api/v1/validation/bulk" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"emails": ["user1@example.com", "user2@example.com"]}'

API Endpoints

Available endpoints and their parameters

POST/api/v1/validation/single

Validate a single email address

Request Body:

{
  "email": "test@example.com"
}
POST/api/v1/validation/bulk

Validate up to 1,000 emails in one request (1 credit per unique email)

Request Body:

{
  "emails": ["user1@example.com", "user2@example.com", ...]
}
POST/api/v1/bulk/upload/preview

Upload CSV file for bulk validation (up to 100,000 emails)

Request:

Content-Type: multipart/form-data
file: [CSV file with email column]
GET/api/v1/bulk/jobs

Get list of bulk validation jobs

Query Parameters:

skip: int (default: 0)
limit: int (default: 10)
GET/api/v1/bulk/jobs/{job_id}

Get details of a specific bulk validation job