Skip to content

Latest commit

 

History

History
54 lines (47 loc) · 1.95 KB

File metadata and controls

54 lines (47 loc) · 1.95 KB
title Introduction
description Tumban scans creator profile URLs for prohibited and restricted business activity and returns a triage recommendation.
icon book-open

{/* sources: src/main.py, src/models/profile.py, src/api/routes_v2.py */}

Tumban analyzes a creator profile URL and returns a structured recommendation your reviewers can act on. Each scan produces a risk score (0–100), a confidence level, reason codes, and an evidence index of the URLs and signals behind the decision.

How it works

Submit a profile URL. Tumban analyses the profile and its external footprint, then returns the result either by webhook or by polling.

Send the profile URL to `POST /api/v2/scan/deep` for a full scan, or `POST /api/v2/scan/quick` for a faster, cheaper profile-only scan. You receive a `scan_id` immediately and the scan begins processing in the background. Tumban delivers the triage report to your `callback_url`, or you can poll `GET /api/v2/scans/{scan_id}` until `status` is no longer `processing`. Use the `recommendation` (`no_flags`, `review_low`, `review_medium`, `review_high`) plus the `evidence_index` to route the profile to your review queue.

Where to start

Mint an API key, submit a scan, and read the result in under five minutes. API keys for server-to-server use, or session tokens for dashboard sessions. Endpoint-by-endpoint reference, derived from the live handlers. Payload format, HMAC verification, and retry behaviour.