Skip to Content
GET
/api/v1/deliver/check

Advisory RCPT-time pre-flight check. By default it is the inbound MTA's question: does the recipient exist here, and do its blocklists and routing rules accept this sender? With submission=true it is the submission MTA's question instead: may the authenticated sender (from, judged as /deliver/outbound judges X-Envelope-From for the same caller) submit to this recipient under its OWN rules, the identity's and credential's recipient allowlists, its outbound address lists, and its account's verified-recipients rule? That mode answers nothing about the recipient's existence: an outside recipient is accepted when the sender's rules allow it, and /deliver/outbound at DATA stays the authority for everything else. Its verdict depends on from, so an MTA must never cache it under the recipient alone.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Query Parameters

to*string

Recipient email address being checked

Length1 <= length
from?|

Sender email address (MAIL FROM). With submission=true it names the sender whose rules are judged; absent or empty (the null return path), nothing is judged and the recipient is accepted.

ip?|

Connecting client IP address

ptr?|

Connecting client reverse DNS PTR hostname

helo?|

Connecting client HELO/EHLO identity

submission?string

true: judge the SENDER's rules for an authenticated submission instead of the recipient's inbound acceptance (default false). Accepted from system and account keys; a sender the caller may not send as, or one that is held, frozen or gone, is accepted here and refused by /deliver/outbound at DATA, which answers it for the whole message.

Value in"true""false"

Response Body

Recipient is accepted: deliverable here (default), or permitted by the sender's own rules (submission=true)

application/json
  1. response
accepted*true

True if recipient address is accepted for delivery

Value intrue
Example Request
curl -X GET 'https://api.open.email/api/v1/deliver/check?to=string'
Example Response
{
  "accepted": true
}