API Reference

GotAScam API

Integrate scam detection into your application. All endpoints are REST-style and return JSON. Base URL: https://gotascam.com/api/v1

Authentication

Free endpoints (text analysis) work without authentication. Pro endpoints require a Bearer token obtained by signing in.

Request header

Authorization: Bearer <your_token>

Get your token by calling POST /auth/login with your email and password.

POST /submit

Submit text content for scam analysis. Free endpoint — no authentication required. Returns a result ID which can be used to fetch the full analysis.

Works anonymously. For permanent result links and history, include a valid Authorization header.

Parameter	Type	Required	Description
content	string	required	The text content to analyse. Max 10,000 characters.

Example request

curl -X POST https://gotascam.com/api/v1/submit \
  -H "Content-Type: application/json" \
  -d '{"content": "Your account has been suspended. Click here urgently."}'

Response (200)

{
  "public_id": "gas_a3f9b2c1",
  "verdict": "scam",
  "score": 87,
  "title": "Likely Scam",
  "summary": "Multiple phishing indicators detected..."
}

GET /results/{public_id}

Fetch the full analysis report for a given result ID.

Parameter	Type	Required	Description
public_id	string	required	The result ID returned by a submit endpoint.

Response (200)

{
  "public_id": "gas_a3f9b2c1",
  "verdict": "scam",
  "score": 87,
  "signals": [...],
  "created_at": "2026-05-29T10:32:00Z"
}

GET /submissions

List the current user's submission history. Requires authentication. Pro users get full history; free users get results from the last 24 hours.

Parameter	Type	Required	Description
page	integer	optional	Page number (default: 1, page size: 20)

Error codes

Code	Meaning
400	Bad request — missing or invalid parameters
401	Unauthorised — invalid or missing token
403	Forbidden — Pro feature requires upgrade
429	Rate limited — too many requests
500	Server error — try again later