Developer Docs

Developer API & Guides.

Sortwell verifies email addresses before you send campaigns. Direct SMTP handshakes, MX record checks, disposable domain detection, and catch-all flags in a single fast JSON API.

Base Production Endpoint
https://www.sortwell.xyz

Authentication

Authenticate your requests using an API key generated from the Sortwell dashboard. Keys begin with the prefix ev_live_.

Supply your key via either the x-api-key or standard Authorization: Bearer header:

Header 1:x-api-key: ev_live_your_key_here
Header 2:Authorization: Bearer ev_live_your_key_here

Need an API key? Generate one with custom rate limits in Settings > API keys.

POST

/api/v1/verify

Runs real-time verification of a single email address. Queries DNS MX servers, establishes a zero-send SMTP handshake, inspects disposable and role patterns, and deducts 1 credit.

curl -X POST https://www.sortwell.xyz/api/v1/verify \
  -H "x-api-key: ev_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

Response Attributes

FieldTypeDescription
statusstring"valid" | "risky" | "invalid" | "unknown"
scorenumberDeliverability confidence score from 0 (bounce) to 100 (inbox verified).
isSafeToSendbooleanPrimary recommendation flag for sending campaigns without bounce penalties.
isDisposablebooleanTrue if domain belongs to a temporary or burner provider (Mailinator, 10MinMail).
isCatchAllbooleanTrue if receiving mail server accepts messages addressed to any non-existent mailbox.
isRoleAccountbooleanIdentifies shared department mailboxes (support@, sales@, billing@, info@).
GET

/api/v1/account

Tests API credentials and returns active credit balance, daily quota, and subscription plan. Automatically invoked during n8n credential connection tests.

curl -X GET https://www.sortwell.xyz/api/v1/account \
  -H "x-api-key: ev_live_your_api_key_here"

Sample 200 OK Response

{
  "success": true,
  "data": {
    "id": "user_2s8...",
    "email": "[email protected]",
    "name": "Alex Turner",
    "plan": "growth",
    "creditsRemaining": 4850,
    "dailyCredits": 500
  }
}

n8n Community Node

Install the verified Sortwell community node package n8n-nodes-sortwell directly from the n8n community directory.

  1. Open Community Nodes in n8nInside n8n, navigate to Settings > Community Nodes > Install.
  2. Enter Package NameType n8n-nodes-sortwell and click Install.
  3. Create CredentialSelect Sortwell API, paste your ev_live_... key and save.

Looking for pre-configured templates? Head over to our Integrations Hub to copy instant workflow recipes.

HTTP Status Codes

CodeMeaningWorkflow Handling
200 OKVerification completed.Returns deliverability data; decrements 1 credit.
400 Bad RequestMissing or malformed email string.Zero credits deducted. Fix incoming field mapping.
401 UnauthorizedInvalid or expired API key.Re-authenticate or generate a new key in Settings.
402 Payment RequiredAccount credit balance is 0.Halts n8n workflow safely to avoid unverified sends. Top up in dashboard.
429 Too Many RequestsRate limit exceeded.Retry with backoff or upgrade rate limit in Settings.