v1.0.0 (Beta)

API Documentation

Welcome to the ScamOrNah API. Integrate real-time fraud detection into your platform. Protect users from malicious phone numbers, websites, and social handles programmatically.

Base URL https://api.scamornah.com/api

Authentication

Authenticate your requests by including your secret key in the Authorization header.

BASH

curl "https://api.scamornah.com/api/search/?q=+23355..." \
  -H "Authorization: Bearer sk_live_..."

Security Warning: Never expose your API keys in client-side code (browsers, mobile apps). Proxy requests through your own backend server.

Verify Identifier

Retrieves the risk profile and verification status.

GET /api/search/

Parameters

Name	Type	Description
q *	string	The identifier to verify (e.g. phone number with country code, domain, or handle).

Example Response

200 OK application/json

{
  "identifier_value": "+23355000000",
  "risk_score": 0.95,
  "risk_level": "CRITICAL",
  "verification_status": "unverified",
  "reports_count": 12,
  "last_reported": "2024-03-20T10:30:00Z",
  "tags": [
    "impersonation",
    "financial_fraud"
  ]
}

Submit Report

File a new fraud report programmatically.

POST /api/reports/submit/

JSON PAYLOAD

{
  "identifier": "+23355000000",
  "description": "User requested urgent mobile money transfer claiming to be bank staff.",
  "evidence_links": ["https://example.com/proof.png"],
  "incident_date": "2024-03-21"
}

Rate Limits

Starter Plan

1,000

Requests / Month

Business Plan

10,000

Requests / Month

Enterprise

Custom

Scaled Volume

Errors

Code	Meaning
400 Bad Request	Missing or malformed parameters.
401 Unauthorized	Missing or invalid API key.
429 Too Many Requests	Rate limit exceeded. Upgrade your plan.