Skip to main content

​
ScanRequest

Input payload for POST /scan.

​
Rules

  • Send exactly one of keywords or domain.
  • keywords replaces the older queries field from previous docs.
  • keywords can include emails, phone numbers, usernames, IPs, passwords, car plates, social IDs, or composite search strings.
Keyword example: 
{
  "keywords": ["user@example.com", "ShadowPlayer228"]
}
Domain example: 
{
  "domain": "example.com"
}

Send exactly one of keywords or domain.

​
keywords
string[]

List of search terms — emails, phone numbers, usernames, IPs, passwords, car plates, social account IDs, or composite queries. Provide this OR domain, not both.

Example:
["user@example.com"]
​
domain
string

Domain name to enumerate emails from and scan. Provide this OR keywords, not both.

Example:

"example.com"