Skip to main content
POST
people.email.threat.check

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
email
string
required

The mailbox address to check.

Required string length: 1 - 320
alsoVerify
boolean
default:false

Also check delivery, at up to two credits rather than one. Default false.

Response

The result

email
string
required

The submitted mailbox address.

threatScore
integer
required

Mailbox threat signal from 0 to 5; zero means undetermined, not safe. This does not score its owner.

Required range: 0 <= x <= 5
threatLevel
enum<string>
required

Mailbox threat level corresponding to the signal.

Available options:
undetermined,
low,
elevated,
moderate,
high,
very_high
status
enum<string>

Delivery verdict, only when alsoVerify was requested.

Available options:
valid,
invalid,
accept_all,
unknown
deliverable
boolean

Whether delivery was confirmed, only with alsoVerify.