Developers

API reference

Open cases from your own tooling and receive verdicts.

Open a scan case for a flagged player from your own tooling, then receive the verdict by webhook. The API returns the same fields the dashboard shows.

Enterprise plans

API access is included with Enterprise 10 and Enterprise 20. See Plans and billing.

Authentication

Send your API key as a bearer token on every request. Keep it on your server: never in a client, a resource or a public repository.

Header http
Authorization: Bearer $TRACE_KEY

Create a case

POST https://api.scanwithtrace.com/v1/cases

Opens a case for a player your anti-cheat flagged. The case waits until the player runs the scanner.

Body

FieldTypeDescription
server_idstringYour server's ID in Trace.
playerstringThe flagged player's identifier, for example steam:11000013a7c4e52.
Request bash
# open a case for a player your anti-cheat flagged
curl -X POST https://api.scanwithtrace.com/v1/cases \
  -H "Authorization: Bearer $TRACE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"server_id": "eastside", "player": "steam:11000013a7c4e52"}'
Response json
// 201 Created
{
  "case_id": "TRC-7F3A-91C2",
  "status": "awaiting_scan",
  "dashboard": "https://scanwithtrace.com/c/7f3a91c2"
}

Response fields

FieldDescription
case_idThe case and report ID.
statusawaiting_scan until the player runs the scanner.
dashboardLink to the case on your dashboard.

Verdict webhook

The case stays open until the player runs the scanner. Your webhook fires the moment the verdict is written, carrying the same fields the dashboard shows. See Reading a verdict for what each field means.