Help Chat
Sign in Get Started
DOCUMENTATION

Everything You Need to Get Started

Comprehensive guides, API documentation, and resources to help you integrate IPFraud Shield seamlessly

Quick Start

Get up and running in minutes

API Reference

Complete API documentation

Integrations

Connect with popular platforms

FAQs

Common questions answered

Getting Started

1

Create Your Account

Sign up for IPFraud Shield and get your API key instantly. No credit card required for the free trial.

curl -X POST https://api.ipfraud.com/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "password": "secure_password"}'
2

Install the SDK

Choose your preferred language and install our lightweight SDK.

npm install @ipfraud/shield
3

Initialize and Verify

Initialize the SDK with your API key and start verifying IP addresses.

const IPFraud = require('@ipfraud/shield');

const ipfraud = new IPFraud('YOUR_API_KEY');

// Check an IP address
const result = await ipfraud.check('192.168.1.1');

if (result.isFraud) {
  console.log('Fraudulent IP detected:', result.reason);
}

API Reference

Authentication Check IP Bulk Check Whitelist Management Analytics Webhooks

Authentication

All API requests require authentication using your API key. Include it in the Authorization header.

# Request Header
Authorization: Bearer YOUR_API_KEY

Check IP Address

Verify if an IP address is fraudulent or legitimate.

Endpoint

POST /v1/check

Request Body

{
  "ip": "192.168.1.1",
  "user_agent": "Mozilla/5.0...",
  "url": "https://example.com/page"
}

Response

{
  "ip": "192.168.1.1",
  "is_fraud": false,
  "risk_score": 15,
  "type": "residential",
  "country": "US",
  "city": "New York",
  "isp": "Verizon",
  "flags": []
}

Integration Examples

WordPress

Plugin available

Protect your WordPress site with our official plugin. One-click installation.

View Plugin →

Shopify

App available

Stop fraudulent orders and protect your Shopify store revenue.

Install App →

Custom Integration

Any platform

Use our REST API or SDKs to integrate with any platform or custom application.

View Docs →

Frequently Asked Questions

How accurate is IPFraud Shield?

Our fraud detection system maintains a 99.9% accuracy rate with minimal false positives. We continuously update our detection algorithms and threat database to ensure the highest level of protection.

Does it slow down my website?

No. IPFraud Shield is designed for speed with average response times under 50ms. Our globally distributed infrastructure ensures minimal latency regardless of your location.

Can I whitelist legitimate IPs?

Yes, you can easily manage whitelists and blacklists through our dashboard or API. This ensures your legitimate users and services are never blocked.

What types of fraud can it detect?

IPFraud Shield detects various types of fraudulent traffic including bots, scrapers, VPN/proxy users, click fraud, account takeover attempts, and more. Our ML models identify patterns across multiple threat vectors.

Is there a free trial available?

Yes! We offer a 14-day free trial with full access to all features. No credit card required. You can also use our free tier for up to 1,000 API calls per month.

Need Help? We're Here for You

Our support team is available 24/7 to help you with any questions or issues

Contact Support Browse Help Center