API Documentation

Comprehensive guide to integrating Realtime Verify's email verification API into your applications

API Documentation in Development

We're working hard to complete our API documentation. You'll receive an email notification when everything is ready for integration.

Getting Started

Everything you need to begin using the API

API Keys

Generate and manage your API keys from the dashboard. We provide both production and test keys for development.

Authorization: Bearer your-api-key

Base URL

https://api.realtimeverify.com/v1

Authentication

Secure access to API endpoints

Bearer Token

All API requests must include your API key in the Authorization header.

GET /verify/single

Authorization: Bearer sk_...

Content-Type: application/json

Keep your API keys secure and never expose them in client-side code

API Endpoints

Available endpoints for email verification

Single Email Verification

POST /verify/single

Verify a single email address in real-time

Batch Verification

POST /verify/batch

Verify multiple email addresses asynchronously

Job Status

GET /jobs/:id/status

Check the status of batch verification jobs

Response Format

Standardized API response structure

Success Response

{
  "success": true,
  "data": {
    "email": "user@example.com",
    "status": "deliverable",
    "score": 0.95,
    "checks": {
      "syntax": true,
      "domain": true,
      "smtp": true
    }
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_EMAIL",
    "message": "Invalid email format"
  }
}

Verification Features

Comprehensive email validation capabilities

Syntax Validation

Checks email format, structure, and RFC compliance

Domain Verification

Validates domain existence and MX records

SMTP Verification

Connects to mail servers to verify mailbox existence

Disposable Detection

Identifies temporary and disposable email services

Risk Assessment

Provides risk scores and confidence levels

Bulk Processing

Handle large lists with progress tracking

Integration Examples

Code examples for popular languages and frameworks

JavaScript/Node.js

Axios, Fetch API

Python

Requests, httpx

cURL

Command line examples

Webhooks

Real-time notifications for verification results

Batch Completion

Receive notifications when batch verification jobs complete

POST /webhook/batch-complete
{
  "job_id": "job_123",
  "status": "completed",
  "total_emails": 1000,
  "deliverable": 850,
  "undeliverable": 150
}

Stay Updated

We're working hard to complete our API documentation. You'll receive an email notification when everything is ready for integration.