EpekDigital Validatr API Documentation

Authentication: All API endpoints require authentication. Use either an API key in the x-api-key header or a JWT token in the Authorization header.

POST /api/validate

Validate email addresses with comprehensive checks

Request Body

{ "emails": ["[email protected]", "[email protected]"], "enableSmtpCheck": false }

Parameters:

emails (required): Array of email addresses to validate (max 1000)
enableSmtpCheck (optional): Enable SMTP connection check (slower but more accurate)

Response

Success Response (200):

{ "success": true, "data": { "jobId": "job_1234567890_abc123", "submitted": 2, "processed": 2, "valid": 1, "invalid": 1, "disposable": 0, "role": 0, "blacklisted": 0, "data": [ { "email": "[email protected]", "status": "valid", "reason": "Email is valid" }, { "email": "[email protected]", "status": "invalid", "reason": "Invalid email format" } ] } }

200 - Success

400 - Invalid input

401 - Unauthorized

500 - Server error

GET /api/status/{jobId}

Check the status of a validation job

Response

Success Response (200):

{
  "success": true,
  "data": {
    "jobId": "job_1234567890_abc123",
    "status": "completed",
    "submitted": 1000,
    "processed": 1000,
    "valid": 850,
    "invalid": 150,
    "disposable": 10,
    "role": 5,
    "blacklisted": 2
  }
}
                        

GET /api/export/{jobId}

Download validation results as CSV

Returns a CSV file with all validation results for the specified job.

200 - CSV file

404 - Job not found

GET /api/stats

Get user statistics and recent jobs

Response

Success Response (200):

{
  "success": true,
  "data": {
    "totalApiCalls": 150,
    "totalEmailsSubmitted": 5000,
    "totalValid": 4200,
    "totalInvalid": 800,
    "totalDisposable": 50,
    "totalRole": 25,
    "totalBlacklisted": 10,
    "totalJobs": 15,
    "recentJobs": [
      {
        "jobId": "job_1234567890_abc123",
        "status": "completed",
        "fileName": "emails.csv",
        "createdAt": "2025-07-09T13:00:00Z"
      }
    ]
  }
}
                        

Email Validation Statuses

valid - Email is valid and deliverable
invalid - Email has syntax errors or invalid domain
disposable - Email uses a disposable/temporary domain
role - Email is a role-based address (admin@, info@, etc.)
blacklisted - Email domain is on a blacklist
risky - Email has suspicious characteristics
accept_all - Domain accepts all emails (less reliable)
unknown - Unable to determine status

Authentication

All API endpoints require authentication. You can use either:

API Key: Include x-api-key: your-api-key in the request header
JWT Token: Include Authorization: Bearer your-jwt-token in the request header

Rate Limits

API requests are rate-limited to ensure fair usage. Contact support for higher limits.

Support

For API support, documentation updates, or to request higher rate limits, please contact our support team.