Skip to main content
Use this page as a quick reference for valid search types and options used by POST /search.

​
Supported search types

Type valueTypical input
Pseudonymjohn_doe
Email Addresstarget@example.com
Domain Nameexample.com
CryptocurrencyWallet address
IP Address8.8.8.8 or IPv6
These values must match the OpenAPI enum exactly.

​
Request shape

{
  "type": "Email Address",
  "value": "target@example.com",
  "options": {
    "include_breached_accounts": true,
    "include_registered_accounts": true,
    "bypass_cache": false
  },
  "webhook": {
    "url": "https://client.example/webhooks/osintly",
    "secret": "super-secret-webhook-key"
  }
}

​
Options reference

FieldTypeNotes
leakedresultsstring[]Allowed values: Hudson Rock, Leak Check, Snusbase, Breach Base, Breach VIP, Leak Osint
modulesuuid[]Restrict execution to selected module IDs
bypass_cachebooleanForce a fresh execution
include_breached_accountsbooleanInclude breached account dataset
include_registered_accountsbooleanInclude registered account dataset
registered_accounts_onlybooleanSupported only for Email Address

​
Module selection behavior (options.modules)

Use options.modules when you want to restrict execution to a known set of modules. 
{
  "type": "Email Address",
  "value": "target@example.com",
  "options": {
    "modules": [
      "4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f",
      "95c36c17-f76e-4911-bd4e-8ea57515b2fb"
    ]
  }
}
Server-side validation rules:
  • Every module ID must exist
  • Every module ID must be listed and currently available
  • Every module ID must be compatible with the selected type
Default behavior:
  • If options.modules is omitted or empty, Osintly runs the default module set for that search type
  • If options.modules contains one or more IDs, execution is limited to that set
If validation fails, the API returns 400 with an explicit validation error.

​
ID and pagination parameters

  • id (path): search UUID
  • source (path): leak provider source code/name
  • page (query): leak source page number, minimum 1

​
Common errors

Request shape or field values are invalid. Check enum values and data types.
Missing or invalid bearer token.
Respect retry headers and retry after the reset window.
Search creation failed at dispatch layer. Retry with backoff.