Anti-Fraud

Get Anti-Fraud Overview

Changed on

Retrieves blocking stats, protection coverage, risk signals and actionable suggestions for a shop in a given timeframe.

get/v1/shops/{shopId}/anti-fraud/overview

Request

Query parameters

startstring

Start of the window. Defaults to 30 days ago.

endstring

End of the window. Defaults to now.

Request body

startstring nullable

Must be a valid date.

endstring nullable

Must be a valid date.

timezonestring nullable

Example request

{
  "start": "2026-11-01T20:00:55",
  "end": "2026-11-01T20:00:55"
}

Response

window_daysinteger
can_read_logsboolean
has_risk_signalsboolean

Example response

{
  "window_days": 1,
  "stats": {
    "active_rules": 1,
    "total_rules": 1,
    "rule_limit": 5000,
    "has_advanced_types": true,
    "blocked": 0,
    "blocked_change": 0,
    "allowed": 0,
    "allowed_change": 0,
    "block_rate": 0,
    "block_rate_change": 0,
    "blocked_24h": 1
  },
  "graph": {
    "dateData": [
      "2026-11-01"
    ],
    "blocksData": [
      0
    ]
  },
  "top_block_reasons": [],
  "coverage": [
    {
      "type": "email",
      "group": "identity",
      "active": 1,
      "total": 1,
      "available": true
    },
    {
      "type": "email_domain",
      "group": "identity",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "disposable_email",
      "group": "identity",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "discord_id",
      "group": "identity",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "ip",
      "group": "network",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "ip_range",
      "group": "network",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "asn",
      "group": "network",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "isp",
      "group": "network",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "vpn",
      "group": "network",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "tor",
      "group": "network",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "country_code",
      "group": "geography",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "city",
      "group": "geography",
      "active": 0,
      "total": 0,
      "available": true
    },
    {
      "type": "user_agent",
      "group": "client",
      "active": 0,
      "total": 0,
      "available": true
    }
  ],
  "can_read_logs": true,
  "has_risk_signals": true,
  "risk_signals": [],
  "suggestions": [
    {
      "id": "block_vpn",
      "severity": "warning",
      "title": "Block VPN and proxy traffic",
      "body": "Buyers hiding behind a VPN, proxy or hosting provider are the most common source of reversed payments. This rule needs no value.",
      "evidence": null,
      "plan_gated": false,
      "review_first": false,
      "action": {
        "type": "create_blacklist",
        "payload": {
          "type": "vpn",
          "match_type": "exact",
          "reason": "Suggested by anti-fraud overview"
        }
      }
    },
    {
      "id": "block_tor",
      "severity": "warning",
      "title": "Block Tor traffic",
      "body": "Tor exit nodes are almost never a real customer, and a blocked Tor order costs you nothing. This rule needs no value.",
      "evidence": null,
      "plan_gated": false,
      "review_first": false,
      "action": {
        "type": "create_blacklist",
        "payload": {
          "type": "tor",
          "match_type": "exact",
          "reason": "Suggested by anti-fraud overview"
        }
      }
    },
    {
      "id": "block_disposable_email",
      "severity": "warning",
      "title": "Block disposable email addresses",
      "body": "Throwaway inboxes let one buyer place the same order again and again after a refund. This rule needs no value.",
      "evidence": null,
      "plan_gated": false,
      "review_first": false,
      "action": {
        "type": "create_blacklist",
        "payload": {
          "type": "disposable_email",
          "match_type": "exact",
          "reason": "Suggested by anti-fraud overview"
        }
      }
    }
  ]
}

Changes

    • breaking

      the response property // became nullable for the status

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      endpoint added