REST API v1.0

BrandedOps API

Integrate brand protection and product verification directly into your applications. Monitor threats, verify products, and automate takedowns programmatically.

Get API Key View Documentation

Introduction

The BrandedOps API provides programmatic access to our brand protection platform. Use it to monitor marketplaces, verify product authenticity, track threats, and automate enforcement actions.

Base URL 
https://api.brandedops.com/v1

Authentication

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

Request Header 
Authorization: Bearer your_api_key_here
Content-Type: application/json

Keep your API keys secure

Never expose API keys in client-side code. Store them in environment variables and use server-side requests.

Rate Limits

API requests are rate limited based on your subscription plan. Rate limit information is included in response headers.

Plan Requests/Minute Requests/Day
Signal Essential 60 1,000
Brand Shield 300 10,000
Global Defense 1,000 Unlimited

Error Handling

The API uses conventional HTTP response codes. Codes in the 2xx range indicate success, 4xx indicate client errors, and 5xx indicate server errors.

Error Response Format 
{
  "error": {
    "code": "invalid_request",
    "message": "The product_id field is required.",
    "details": {
      "field": "product_id",
      "reason": "missing_required_field"
    }
  }
}

Products

GET /products

Retrieve a list of all products in your catalog with optional filtering and pagination.

Query Parameters

Parameter Type Description
page integer Page number for pagination (default: 1)
per_page integer Results per page, max 100 (default: 25)
status string Filter by status: active, inactive, flagged
Response 
{
  "data": [
    {
      "id": "prod_abc123",
      "name": "Premium Widget Pro",
      "sku": "WDG-PRO-001",
      "gtin": "012345678905",
      "status": "active",
      "threats_count": 3,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 250
  }
}
POST /products/verify

Verify a product's authenticity using serial number, GTIN, or image analysis.

Request Body

Parameter Type Description
serial_number string Product serial number
gtin string Global Trade Item Number (UPC/EAN)
image_url string URL to product image for AI analysis
Example Request 
curl -X POST https://api.brandedops.com/v1/products/verify \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "serial_number": "SN-2024-ABC123",
    "gtin": "012345678905"
  }'
Response 
{
  "verified": true,
  "confidence": 0.98,
  "product": {
    "id": "prod_abc123",
    "name": "Premium Widget Pro",
    "brand": "Acme Corp"
  },
  "verification_id": "ver_xyz789",
  "verified_at": "2024-01-20T14:25:00Z"
}

Threats

GET /threats

Retrieve detected threats including counterfeits, unauthorized sellers, and IP violations.

Query Parameters

Parameter Type Description
type string Filter by type: counterfeit, unauthorized, trademark
marketplace string Filter by marketplace: amazon, ebay, alibaba, etc.
status string Filter by status: active, pending, resolved
severity string Filter by severity: low, medium, high, critical
Response 
{
  "data": [
    {
      "id": "thr_def456",
      "type": "counterfeit",
      "severity": "high",
      "marketplace": "amazon",
      "listing_url": "https://amazon.com/dp/B0EXAMPLE",
      "seller": {
        "name": "cheap_goods_123",
        "id": "A1SELLERID"
      },
      "product": {
        "id": "prod_abc123",
        "name": "Premium Widget Pro"
      },
      "estimated_revenue_loss": 4500.00,
      "detected_at": "2024-01-19T08:15:00Z",
      "status": "active"
    }
  ],
  "meta": {
    "total_count": 47,
    "total_revenue_at_risk": 125000.00
  }
}
POST /threats/{threat_id}/takedown

Submit a takedown request for a detected threat. We'll handle the enforcement process with the marketplace.

Path Parameters

Parameter Type Description
threat_id required string The threat identifier

Request Body

Parameter Type Description
reason required string Takedown reason: counterfeit, trademark, copyright
notes string Additional notes for the enforcement team
priority string Priority level: normal, high, urgent
Response 
{
  "takedown_id": "tkd_ghi789",
  "status": "submitted",
  "estimated_completion": "2024-01-22T00:00:00Z",
  "marketplace_case_id": "AMZ-CASE-123456"
}

Analytics

GET /analytics/dashboard

Get an overview of your brand protection metrics including threats, takedowns, and revenue impact.

Response 
{
  "period": "last_30_days",
  "threats": {
    "total": 847,
    "by_type": {
      "counterfeit": 523,
      "unauthorized": 289,
      "trademark": 35
    },
    "by_severity": {
      "critical": 45,
      "high": 198,
      "medium": 412,
      "low": 192
    }
  },
  "takedowns": {
    "submitted": 234,
    "completed": 198,
    "pending": 36,
    "success_rate": 0.98
  },
  "revenue": {
    "at_risk": 425000.00,
    "recovered": 127500.00,
    "recovery_rate": 0.30
  },
  "marketplaces": [
    {"name": "Amazon", "threats": 412},
    {"name": "eBay", "threats": 198},
    {"name": "Alibaba", "threats": 156}
  ]
}

Webhooks

Receive real-time notifications when events occur in your BrandedOps account. Configure webhook endpoints in your dashboard settings.

Available Events

Event Description
threat.detected A new threat has been detected
threat.updated A threat's status or details have changed
takedown.submitted A takedown request has been submitted
takedown.completed A takedown has been successfully completed
verification.completed A product verification has been processed
Webhook Payload Example 
{
  "event": "threat.detected",
  "timestamp": "2024-01-20T14:30:00Z",
  "data": {
    "threat_id": "thr_def456",
    "type": "counterfeit",
    "severity": "high",
    "marketplace": "amazon",
    "product_id": "prod_abc123",
    "estimated_revenue_loss": 4500.00
  }
}

Ready to Integrate?

Get your API key and start protecting your brand programmatically. Full SDK support for Python, Node.js, PHP, and more.

Get Your API Key