Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tumban.com/llms.txt

Use this file to discover all available pages before exploring further.

Submit a single profile URL for ToS compliance analysis. The request returns a scan_id immediately; processing happens in the background. 
POST /api/v2/scan

​
Request body

​
profile_url
string
required
The creator profile URL to analyze. Must be a valid HTTP or HTTPS URL.
​
callback_url
string
HTTPS endpoint Tumban will POST the result to when the scan finishes. Optional: if omitted, Tumban falls back to the organization’s default_callback_url. If neither is set, the scan still runs and the result is available via GET /api/v2/scans/{scan_id} — no webhook is sent.
​
metadata
object
default:"{}"
Arbitrary JSON object echoed back in the webhook payload and persisted on the scan record. Use it to thread your own correlation ids (reviewer_id, case_id, etc.) through the pipeline.

​
Response

​
scan_id
string
required
UUID of the scan. Use it to poll GET /api/v2/scans/{scan_id}.
​
status
string
required
Always processing on success. See Status values.
​
submitted_at
string
required
ISO 8601 UTC timestamp of when Tumban accepted the scan.
​
estimated_completion
string
required
ISO 8601 UTC timestamp of the expected completion time. The scan typically finishes in under two minutes.

​
Example

curl -X POST https://api.tumban.com/api/v2/scan \
  -H "Authorization: Bearer sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_url": "https://creator.example/username",
    "callback_url": "https://your-app.example/webhooks/tumban",
    "metadata": {"reviewer_id": "rv_42"}
  }'

{
  "scan_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "submitted_at": "2026-04-29T12:00:00",
  "estimated_completion": "2026-04-29T12:02:00"
}

​
Using the dashboard

1

Open Scan

From the sidebar, click Scan.
2

Submit a profile URL

In the Submit Scan tile, paste the profile URL into the Profile URL field. By default the result is delivered via your organization’s default callback URL.To override per-scan, toggle Send result to callback URL on and enter a URL in the revealed Callback URL field.
3

Submit and watch

Click Submit Scan. The new row appears at the top of the Scans table with status Processing. The page polls in-flight rows every five seconds and updates them in place. Click the row once it reaches a terminal status to open Get scan detail.