Skip to main content
POST
/
search
Create a new search
curl --request POST \
  --url https://api.osint.ly/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "Email Address",
  "value": "target@example.com",
  "options": {
    "leakedresults": [
      "Leak Check",
      "Snusbase"
    ],
    "modules": [
      "4a8cbb96-70df-4bd6-8f4a-9c0bf5ffde1f"
    ],
    "bypass_cache": false,
    "include_breached_accounts": true,
    "include_registered_accounts": true,
    "registered_accounts_only": false
  },
  "webhook": {
    "url": "https://client.example/webhooks/osintly",
    "secret": "super-secret-webhook-key"
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "search": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "Pseudonym",
      "value": "<string>",
      "status": "pending"
    },
    "job": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dispatched_at": "2023-11-07T05:31:56Z",
      "via_cache": true
    },
    "options": {
      "leakedresults": [
        "Hudson Rock"
      ],
      "modules": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "bypass_cache": false,
      "include_breached_accounts": false,
      "include_registered_accounts": true,
      "registered_accounts_only": false
    },
    "leakedresults": [
      "<string>"
    ]
  },
  "meta": {
    "bypass_cache": true,
    "environment": "<string>",
    "gateway": "<string>"
  },
  "code": 200
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
type
enum<string>
required
Available options:
Pseudonym
value
string
required

Pseudonym to search

options
object
webhook
object

Response

Search queued

success
enum<boolean>
required
Available options:
true
message
string
required
data
object
required
meta
object
required
code
enum<integer>
required
Available options:
200