Skip to main content

​
ScanResponse

Contains scan_id, status, breach count, and optional discovered emails/message fields.
​
scan_id
string<uuid>

Unique identifier for retrieving scan results via GET /scan/{scan_id}

​
status
enum<string>

Scan result status

Available options:
success,
no_results,
no_queries
​
total_breaches
integer

Total number of breaches found

Required range: x >= 0
​
discovered_emails
string[]

Emails discovered from domain enumeration (only present when domain was provided)

​
message
string

Additional context (e.g. when no queries were provided)