Skip to main content
POST
email.directory.tenant.resolve

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string
required

Organisation domain, without a scheme or path.

Maximum string length: 253
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$

Response

The result

domain
string
required

The domain requested.

discovered
boolean
required

Public directory discovery succeeded. This grants no mailbox access and does not verify domain ownership.

ref
string

Reference to what this call created. Pass it as ref to future directory onboarding.