Skip to main content
POST
Find a verification code or link

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

inboxId
string
required

Inbox id

Body

application/json
from
string

Sender name/address substring (case-insensitive). Omit if unknown: providers often send from a different domain. Mismatches return candidates with their actual sender and code/link

Maximum string length: 320
subject_contains
string

Only mail whose subject contains this text (case-insensitive)

Maximum string length: 200
since

ISO timestamp or event cursor; defaults to the last 15 minutes. Prefer the time you triggered verification. When changing filters, omit since or reuse that timestamp, not the returned cursor

Pattern: ^\d{1,18}$
wait
integer

Seconds to wait after checking recent mail; default 20, maximum 25. Use 0 for an immediate lookup

Required range: 0 <= x <= 25

Response

Code/link or sender-mismatch candidates

message_id
string | null
code
string | null
from
object
subject
string
received_at
string<date-time>
confidence
number | null
screening
object | null
found
boolean
cursor
string
reason
enum<string>
Available options:
sender_filter_mismatch
hint
string
candidates
object[]
Maximum array length: 3