Difference between revisions of "MaxMind"
(→MaxMind Fraud Risk Score) |
(→Custom Rules) |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
==Setup and Configuration== | ==Setup and Configuration== | ||
| − | + | ||
| − | To enable MaxMind integration, follow the steps below: | + | To enable MaxMind integration in WHMCS 8.2 and later, follow the steps below: |
| − | + | ||
| − | * Navigate to '''Setup > Fraud Protection | + | * Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]'''. |
| − | * Check the Enable checkbox | + | * Click '''Activate''' for MaxMind. |
| − | * Enter your MaxMind User ID and the Licence Key. You can find these within the My License Key page inside the MaxMind online portal. | + | * Check the checkbox to enable MaxMind. |
| − | * Click Save | + | * Enter your '''MaxMind User ID''' and the '''Licence Key'''. You can find these within the '''My License Key''' page inside the MaxMind online portal. |
| + | * Click '''Save'''. | ||
| + | |||
| + | To enable MaxMind integration in WHMCS 8.1 and earlier, follow the steps below: | ||
| + | |||
| + | * Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''. | ||
| + | * Choose '''MaxMind''' from the menu. | ||
| + | * Check the '''Enable''' checkbox. | ||
| + | * Enter your '''MaxMind User ID''' and the '''Licence Key'''. You can find these within the '''My License Key''' page inside the MaxMind online portal. | ||
| + | * Click '''Save'''. | ||
==Configuration Options== | ==Configuration Options== | ||
| Line 20: | Line 29: | ||
* '''Factors''' - minFraud Factors builds on the same data as Insights, and then provides additional scoring based on the order input. Check the comparison page for the subscores that can be provided.''' | * '''Factors''' - minFraud Factors builds on the same data as Insights, and then provides additional scoring based on the order input. Check the comparison page for the subscores that can be provided.''' | ||
| − | Essentially, the higher the level, the more analytics and metrics feedback you will receive. The different service types each have differing costs associated with them. | + | Essentially, the higher the level, the more analytics and metrics feedback you will receive. The different service types each have differing costs associated with them. For more information, see MaxMind's [https://support.maxmind.com/hc/en-us/articles/4407833140123-Compare-the-minFraud-Services Compare the minFraud Services] documentation. |
===MaxMind Fraud Risk Score=== | ===MaxMind Fraud Risk Score=== | ||
| Line 48: | Line 57: | ||
===Custom Rules=== | ===Custom Rules=== | ||
| − | Custom Rules can be used to reject an orders based on a combination of rules you setup. Custom Rules can be created and managed from within your MaxMind account, more information is available in the [https://support.maxmind.com/ | + | Custom Rules can be used to reject an orders based on a combination of rules you setup. Custom Rules can be created and managed from within your MaxMind account, more information is available in the [https://support.maxmind.com/hc/en-us/articles/4408801942811-Use-Custom-Rules-and-Dispositions Custom Rules documentation].<br/> |
| + | Accept Custom Rules have no effect on the order status. | ||
| − | ==Upgrading from MaxMind V1== | + | ==Upgrading from MaxMind V1.x to V2== |
| − | Your configuration will be automatically updated when upgrading a WHMCS installation from WHMCS 7.5 or earlier to WHMCS 7.6. However, one additional configuration is required to allow fraud checking to continue. The new User ID configuration parameter must be set for API Authentication to succeed. Your MaxMind User ID can be found on the My License Key page in a MaxMind account. | + | Your configuration will be automatically updated when upgrading a WHMCS installation from WHMCS 7.5 or earlier to WHMCS 7.6 or later. However, one additional configuration is required to allow fraud checking to continue. The new '''User ID''' configuration parameter must be set for API Authentication to succeed. Your MaxMind User ID can be found on the My License Key page in a MaxMind account. |
==Legacy MaxMind Module== | ==Legacy MaxMind Module== | ||
If you are looking for documentation for the MaxMind module in WHMCS 7.5 or earlier, please see [[MaxMind_Legacy_Module]] | If you are looking for documentation for the MaxMind module in WHMCS 7.5 or earlier, please see [[MaxMind_Legacy_Module]] | ||
| + | |||
| + | ==Common Errors== | ||
| + | ===MAX_REQUESTS_REACHED=== | ||
| + | This means you have run out of MinFraud queries on your MaxMind account, you will need to purchase more queries via the MaxMind website. | ||
| + | |||
| + | ===INVALID_LICENSE_KEY=== | ||
| + | This error indicates that the license key you provided in your settings is incorrect. It can also indicate that your license key is not valid for the service you are attempting to access. You should first verify your license key has been properly entered at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''. If the license key is correct, you should contact MaxMind to inquire why your license key is returning as invalid. | ||
| + | |||
| + | ===LICENSE_REQUIRED=== | ||
| + | This error will be returned if no license key has been provided. Please check your license key setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''. | ||
| + | |||
| + | ===USER_ID_REQUIRED=== | ||
| + | This error will be returned if no User ID has been provided. Please check your license key setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''. | ||
| + | |||
| + | ===PERMISSION_REQUIRED=== | ||
| + | This is returned if you do not have permission to use the service. Please contact MaxMind for more information. | ||
| + | |||
| + | ===IP_NOT_FOUND=== | ||
| + | This error will be returned if the IP address is not valid, if it is not public, or if it is not in our GeoIP database. | ||
| + | |||
| + | ===CITY_NOT_FOUND=== | ||
| + | MaxMind maintain a list of valid cities, this city in the client's Profile at the time of ordering must match one of the cities on MaxMind's list, otherwise the order will be rejected with this error. | ||
| + | |||
| + | {{modules}} | ||
Latest revision as of 14:44, 17 November 2022
MaxMind is a leading provider of IP intelligence and online fraud prevention tools.
Contents
Setup and Configuration
To enable MaxMind integration in WHMCS 8.2 and later, follow the steps below:
- Navigate to Configuration () > System Settings > Fraud Protection.
- Click Activate for MaxMind.
- Check the checkbox to enable MaxMind.
- Enter your MaxMind User ID and the Licence Key. You can find these within the My License Key page inside the MaxMind online portal.
- Click Save.
To enable MaxMind integration in WHMCS 8.1 and earlier, follow the steps below:
- Navigate to Configuration () > System Settings > Fraud Protection or, prior to WHMCS 8.0, Setup > Fraud Protection.
- Choose MaxMind from the menu.
- Check the Enable checkbox.
- Enter your MaxMind User ID and the Licence Key. You can find these within the My License Key page inside the MaxMind online portal.
- Click Save.
Configuration Options
Choosing a Service Type
MaxMind offers three different levels of check at the time of writing:
- Score - minFraud score provides only a risk score in WHMCS. No other data is available when using this check type. MaxMind recommend this check type to build your own risk modelling.
- Insights - minFraud Insights provide a wide range of data to check the potential risk of an order. Information regarding the IP location, the country data and email address is provided with this check type. minFraud Insights is the most comparable offering to the older V1 API.
- Factors - minFraud Factors builds on the same data as Insights, and then provides additional scoring based on the order input. Check the comparison page for the subscores that can be provided.
Essentially, the higher the level, the more analytics and metrics feedback you will receive. The different service types each have differing costs associated with them. For more information, see MaxMind's Compare the minFraud Services documentation.
MaxMind Fraud Risk Score
Orders that receive a risk score higher than the value entered here will be marked as fraudulent and prevented from completing checkout.
The default value is 20. A value between 0.01 and 99.9 can be entered. This threshold can then be adjusted up or down depending upon results. For more information refer to What is the riskScore?
Entering 0 in the Risk Score field will disable checking this option and is not recommended.
Reject Free Email Service
Ticking this option checks if the e-mail domain used by the customer is from a free e-mail provider and if so will flag the order as fraud. Examples of free e-mail providers include the following: Yahoo.com, Gmail.com, and MSN.com. The MaxMind system currently has categorised 31,000 free e-mail domain providers around the world.
Reject Country Mismatch
Select this option to mark an order as fraudulent if the billing address provided by a client is significantly different from the location of the IP Address used to place the order.
Reject Anonymous Networks
Select this option to mark an order as fraudulent if the order is placed via an anonymous network such as a proxy or VPN.
Reject High Risk Country
Select this option to mark an order as fraudulent if the transaction's billing address or IP address is located in a country that MaxMind has flagged as high risk.
Custom Rules
Custom Rules can be used to reject an orders based on a combination of rules you setup. Custom Rules can be created and managed from within your MaxMind account, more information is available in the Custom Rules documentation.
Accept Custom Rules have no effect on the order status.
Upgrading from MaxMind V1.x to V2
Your configuration will be automatically updated when upgrading a WHMCS installation from WHMCS 7.5 or earlier to WHMCS 7.6 or later. However, one additional configuration is required to allow fraud checking to continue. The new User ID configuration parameter must be set for API Authentication to succeed. Your MaxMind User ID can be found on the My License Key page in a MaxMind account.
Legacy MaxMind Module
If you are looking for documentation for the MaxMind module in WHMCS 7.5 or earlier, please see MaxMind_Legacy_Module
Common Errors
MAX_REQUESTS_REACHED
This means you have run out of MinFraud queries on your MaxMind account, you will need to purchase more queries via the MaxMind website.
INVALID_LICENSE_KEY
This error indicates that the license key you provided in your settings is incorrect. It can also indicate that your license key is not valid for the service you are attempting to access. You should first verify your license key has been properly entered at Configuration () > System Settings > Fraud Protection or, prior to WHMCS 8.0, Setup > Fraud Protection. If the license key is correct, you should contact MaxMind to inquire why your license key is returning as invalid.
LICENSE_REQUIRED
This error will be returned if no license key has been provided. Please check your license key setting at Configuration () > System Settings > Fraud Protection or, prior to WHMCS 8.0, Setup > Fraud Protection.
USER_ID_REQUIRED
This error will be returned if no User ID has been provided. Please check your license key setting at Configuration () > System Settings > Fraud Protection or, prior to WHMCS 8.0, Setup > Fraud Protection.
PERMISSION_REQUIRED
This is returned if you do not have permission to use the service. Please contact MaxMind for more information.
IP_NOT_FOUND
This error will be returned if the IP address is not valid, if it is not public, or if it is not in our GeoIP database.
CITY_NOT_FOUND
MaxMind maintain a list of valid cities, this city in the client's Profile at the time of ordering must match one of the cities on MaxMind's list, otherwise the order will be rejected with this error.
Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet
Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain
Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign
Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible