API Documentation

Build fraud detection, bot protection, and trust intelligence into your application.

SherGuard APIs help developers analyze email risk, device risk, bot behavior, API abuse, payment fraud, and suspicious activity using scoped API keys and real-time trust intelligence.

Start Free Developer Overview
Authentication

Send your SherGuard API key with every request.

SherGuard uses organization-scoped API keys. Each key can be limited to specific modules so your applications only access the trust intelligence features they are allowed to use. 

x-api-key: sherguard_your_api_key_here
Content-Type: application/json
Base URL

Use the SherGuard API base URL for production requests.

Public API endpoints are designed for backend integrations, signup protection, checkout protection, API security, and trust monitoring. 

https://sherguard-api.onrender.com
Available Endpoints

Trust intelligence APIs for fraud and abuse detection.

Each endpoint returns risk scoring, reasons, signals, confidence, and recommended decisions your business can use in real time.

Email Risk Intelligence

Detect disposable emails, suspicious domains, fake signups, role-based accounts, and risky identity signals.

POST /v1/email-risk
{
  "email": "test@temp-mail.org"
}

Device Risk Intelligence

Analyze user agents, screen size, timezone, browser behavior, automation indicators, and risky environments.

POST /v1/device-risk
{
  "user_agent": "Headless Bot Browser",
  "screen_size": "800x600",
  "timezone": "Unknown",
  "language": "unknown"
}

Bot Detection Intelligence

Analyze session timing, click volume, mouse movement, scroll activity, and automation behavior signals.

POST /v1/bot-risk
{
  "session_time": 8,
  "clicks": 220,
  "mouse_movement": false,
  "scroll_activity": false,
  "keypress_activity": false
}

API Abuse Intelligence

Monitor burst traffic, repeated requests, endpoint misuse, credential abuse, missing headers, and suspicious API clients.

POST /v1/api-abuse
{
  "endpoint": "/api/login",
  "method": "POST",
  "status_code": 401,
  "rate": 240,
  "repeated_requests": 40
}

Payment Fraud Intelligence

Analyze risky payments, billing mismatches, failed attempts, proxy or VPN usage, velocity fraud, and checkout risk.

POST /v1/payment-fraud
{
  "amount": 1499,
  "currency": "USD",
  "billing_country": "US",
  "shipping_country": "GB",
  "failed_attempts": 3
}
Response Format

Receive actionable trust intelligence in every response.

SherGuard responses are designed to help applications decide whether to allow, monitor, challenge, review, or block suspicious activity. 

{
  "success": true,
  "module": "Email Risk Intelligence",
  "risk_level": "High Risk",
  "score": 91,
  "decision": "Block",
  "confidence": "High",
  "reasons": [
    "Disposable email domain detected",
    "Temporary provider pattern found"
  ],
  "signals": {
    "domain_type": "Disposable",
    "provider_type": "Temporary"
  }
}
API Key Scopes

Control which modules each API key can access.

Scoped API keys help protect your organization by limiting keys to only the modules needed by each application, backend service, or integration.

Email Risk Scope

Allow applications to analyze signup emails and suspicious identity signals.

Device Risk Scope

Allow applications to analyze browsers, user agents, and device environments.

Bot Detection Scope

Allow applications to analyze session behavior, automation, and bot signals.

API Abuse Scope

Allow backend services to monitor suspicious API traffic and endpoint abuse.

Payment Fraud Scope

Allow checkout systems to analyze risky payments and fraud indicators.

Usage Monitoring

Track API usage, module access, plan limits, and organization activity from the dashboard.

Integration Flow

Simple integration for production systems.

SherGuard can be connected to signup flows, checkout systems, API gateways, backend services, and trust monitoring workflows.

1

Create an API key

Generate a scoped key from your SherGuard dashboard for the modules your application needs.

2

Send trust signals

Send email, device, bot, API, or payment data to the correct SherGuard endpoint.

3

Apply the decision

Use the risk score, reasons, and recommended decision inside your product workflow.

Start integrating SherGuard APIs.

Create your organization, generate scoped API keys, and connect real-time trust intelligence into your application.

Start Free