osintabuse
DEVELOPER REFERENCE / GET STARTED

osintabuse documentation

One identifier.
A structured response.

Use the workspace to search indexed records and inspect their source metadata, chronology and categories.

The local browser API uses your workspace session. Customer API keys are not enabled.
01

Authentication

Open a workspace first. The browser uses an HttpOnly session cookie. Mutating requests require the exact application origin and the session’s CSRF token in the X-CSRF-Token header.

GET/api/sessionRead session and CSRF token

The session endpoint returns the current workspace state and its CSRF token. Keep session credentials private.

03

Read the response

{
  "result": {
    "mode": "live",
    "engine": "search",
    "masked": "al•••@example.com",
    "counts": {
      "matched": 12,
      "records": 12,
      "buckets": 2
    },
    "censored": true,
    "partial": false
  },
  "creditsCharged": 1
}
matchedIndexed matches reported by the search statistics.
recordsUnique metadata records loaded for this request.
partialTrue when the result is incomplete or a display limit was reached.
statisticsRecord dates, collection counts and file categories.

Matching a document does not confirm a breach. File contents, passwords and session tokens are excluded from the displayed response.

04

Limits & errors

Workspaces start with 5 welcome credits. A successful live search costs one credit and failures are refunded. Free account identifiers and document details are censored on the server. The interface displays 25 records at a time and supports up to 1,000 metadata records per search. A partial result is labeled explicitly.

400Invalid identifier or missing purpose.
401 / 403Workspace authentication or session validation failed.
402No search credits remain.
429Search rate or quota limit reached.
502 / 503Search temporarily unavailable. Retry later.
Run a search