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.

You’ll need a Tumban account with an active organization. Sign in to the dashboard before you start.
1

Create an API key

From the dashboard, generate an API key. The raw key (sk_…) is shown exactly once — copy it now and store it in your secret manager.See Create API key for the equivalent API call.
2

Submit a scan

Send the profile URL and a callback_url you control. The response returns immediately with a scan_id.
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"}
  }'
Response:
{
  "scan_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "submitted_at": "2026-04-29T12:00:00",
  "estimated_completion": "2026-04-29T12:02:00"
}
3

Receive the result

A scan typically completes in under two minutes. You can either:
  • Wait for the webhook at your callback_url — see Webhook payload.
  • Poll GET /api/v2/scans/{scan_id} until status is one of completed, completed_with_partial, or failed.
The triage report includes recommendation, risk_score, confidence, reason_codes, and evidence_index. See Recommendations for how to act on each tier.

​
Next steps

Configure a default callback

Avoid sending callback_url on every request.

Verify webhook signatures

Confirm every payload was sent by Tumban.

Submit a batch

Submit multiple profiles in a single request.

Read scan results

The full triage report shape.