Get Fraud Rules - Affonso Docs

curl -X GET "https://api.affonso.io/v1/program/fraud-rules" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "success": true,
  "data": {
    "self_referral_mode": "detect",
    "cross_program_ban_mode": "off",
    "duplicate_payout_mode": "block",
    "suspicious_email_mode": "detect",
    "banned_referral_mode": "off",
    "paid_traffic_mode": "off",
    "blocked_country_mode": "block",
    "banned_referral_config": null,
    "blocked_country_config": {
      "countries": ["CN", "RU", "NG"]
    },
    "paid_traffic_config": null
  }
}

GET

program

fraud-rules

curl -X GET "https://api.affonso.io/v1/program/fraud-rules" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "success": true,
  "data": {
    "self_referral_mode": "detect",
    "cross_program_ban_mode": "off",
    "duplicate_payout_mode": "block",
    "suspicious_email_mode": "detect",
    "banned_referral_mode": "off",
    "paid_traffic_mode": "off",
    "blocked_country_mode": "block",
    "banned_referral_config": null,
    "blocked_country_config": {
      "countries": ["CN", "RU", "NG"]
    },
    "paid_traffic_config": null
  }
}

Retrieve the fraud detection rule configurations for your program. Each rule can be set to off, detect (flag but allow), or block (prevent the action).

Response

success

boolean

Always true for successful responses

data

object | null

The fraud rules object, or null if not yet configured.

Show Data Object Properties

self_referral_mode

string

Self-referral detection: off, detect, or block

cross_program_ban_mode

string

Cross-program ban detection: off, detect, or block

duplicate_payout_mode

string

Duplicate payout detection: off, detect, or block

suspicious_email_mode

string

Suspicious email detection: off, detect, or block

banned_referral_mode

string

Banned referral detection: off, detect, or block

paid_traffic_mode

string

Paid traffic detection: off, detect, or block

blocked_country_mode

string

Blocked country detection: off, detect, or block

banned_referral_config

object | null

Configuration for banned referral detection

blocked_country_config

object | null

Configuration for blocked country detection (e.g. country list)

paid_traffic_config

object | null

Configuration for paid traffic detection

curl -X GET "https://api.affonso.io/v1/program/fraud-rules" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "success": true,
  "data": {
    "self_referral_mode": "detect",
    "cross_program_ban_mode": "off",
    "duplicate_payout_mode": "block",
    "suspicious_email_mode": "detect",
    "banned_referral_mode": "off",
    "paid_traffic_mode": "off",
    "blocked_country_mode": "block",
    "banned_referral_config": null,
    "blocked_country_config": {
      "countries": ["CN", "RU", "NG"]
    },
    "paid_traffic_config": null
  }
}

Update Portal Settings Update Fraud Rules

​Response

Response