Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for testing an address against the configured rules

address
string
required

The address to test

Required string length: 1 - 320
direction
enum<string>
required

SEND governs who this org's agents may email (enforced when a send is attempted); RECEIVE governs whose mail is accepted for them (enforced at ingest, before the message is stored or any webhook fires). Reply-scope is not implemented.

Available options:
SEND,
RECEIVE
agentId
string

Evaluate as this agent. Omit to evaluate against org-wide rules only.

Pattern: ^[cC][^\s-]{8,}$

Response

200 - application/json

OK

The verdict the send path or ingest would reach for this address

allowed
boolean
required

Whether this address is permitted in this direction

reason
enum<string>
required

Why. 'allowlist-default-deny' means no rule names this address but an allow-list is active and does not cover it — the case operators most often mistake for a bug.

Available options:
no-rules,
explicit-allow,
explicit-block,
allowlist-default-deny
scope
enum<string> | null
required

Which scope decided, or null when nothing matched and the default applied

Available options:
agent,
org
matchedRuleId
string | null
required

The rule that decided, or null when the verdict came from a default

Pattern: ^[cC][^\s-]{8,}$