Difference between revisions of "MaxMind Legacy Module"

Latest revision as of 17:22, 26 April 2022

MaxMind offers 22 different risk ratings and scores to enable WHMCS and you to decide whether an order is fraudulent. For details about each of the individual checks, see the minFraud White Paper. MaxMind allows you to do both basic fraud checks and phone verifications.

Configuration

To configure the MaxMind service:

Go to Configuration () > System Settings > Fraud Protection or, prior to WHMCS 8.0, Setup > Fraud Protection.
Click MaxMind.
Check Enable.
Enter the license key that MaxMind provided when you signed up.
Select the criteria that an order must satisfy before being automatically approved. If these criteria are not met then the order will remain in the Fraud status and the invoice will have the Cancelled status.

Reject Free Email Service

Enable this to flag the order as fraud if the customer's email's domain is from one of MaxMind's 31,000 catalogued free email provider (for example, yahoo.com, gmail.com, or msn.com).

Reject Country Mismatch

Enable this to flag the order as fraud if the client's billing address is significantly different from the location of the IP address with which they placed the order.

Reject Anonymous Proxy

Enable this to flag the order as fraud if the client used an anonymous proxy.

Reject High Risk Country

Enable this to flag the order as fraud if the transaction's billing address or IP address are from a country that MaxMind has flagged as high risk.

MaxMind Fraud Risk Score

Enter a value for the maximum allowable risk score. MaxMind assigns a risk score to each order according to their criteria. MaxMind will flag any order that exceeds the risk score you enter as fraud.

MaxMind recommends that you set this to 2.5 for the original scoring system or 25 if you enable the new risk score system via the Use New Risk Score setting below. For more information, see Web Services Score.

Use New Risk Score

Enable this to use MaxMind's newer risk score system on a scale of 1-100.

Do Not Send City

Enable this to skip checking the city on orders against MaxMind's list of world cities.

By default, if the client's city is not in MaxMind's list, MaxMind will flag the order as fraud. However, sometimes Maxmind's list may be incomplete or there may be multiple spellings of the same city. In these cases, the check could reject legitimate orders.

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 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.

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

@@ Line 3: / Line 3: @@
 ==Configuration==
-To configure the MaxMind service navigate to '''Setup > Fraud Protection > MaxMind'''. Tick the Enable checkbox and enter the Licence Key provided by MaxMind when you signed up.
+To configure the MaxMind service:
-There are a number of options available so you can select the exact criteria an order must satisfy before being automatically approved. If these criteria are not met then the order will remain in "Fraud" status and the invoice will be "Cancelled".
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.
+# Click '''MaxMind'''.
+# Check '''Enable'''.
+# Enter the license key that MaxMind provided when you signed up.
+# Select the criteria that an order must satisfy before being automatically approved. If these criteria are not met then the order will remain in the '''Fraud''' status and the invoice will have the '''Cancelled''' status.
 ===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 categorized 31,000 free e-mail domain providers around the world.
+Enable this to flag the order as fraud if the customer's email's domain is from one of MaxMind's 31,000 catalogued free email provider (for example, <tt>yahoo.com</tt>, <tt>gmail.com</tt>, or <tt>msn.com</tt>).
 ===Reject Country Mismatch===
-The if billing address provided by the client is significantly different from the location of the IP Address used to place the order, it will be flagged as fraud.
+Enable this to flag the order as fraud if the client's billing address is significantly different from the location of the IP address with which they placed the order.
 ===Reject Anonymous Proxy===
-Orders placed via an anonymous proxy are highly likely to be fraudulent. Ticking this option means order will be rejected.
+Enable this to flag the order as fraud if the client used an anonymous proxy.
 ===Reject High Risk Country===
-This field determines if the transaction's billing address or IP address is located in a country that MaxMind has flagged as high risk. A positive matches means that either the IP address or billing address is located in [http://www.maxmind.com/en/web_services_score2 one of the following countries].
+Enable this to flag the order as fraud if the transaction's billing address or IP address are from [http://www.maxmind.com/en/web_services_score2 a country that MaxMind has flagged as high risk].
 ===MaxMind Fraud Risk Score===
-Each order is given a risk score by MaxMind based on the criteria explained in their documentation above. Order with a risk score higher than the value entered here will be flagged as fraudulent.
+Enter a value for the maximum allowable risk score. MaxMind assigns [http://www.maxmind.com/en/web_services_score2 a risk score] to each order according to their criteria. MaxMind will flag any order that exceeds the risk score you enter as fraud.
+MaxMind recommends that you set this to <tt>2.5</tt> for the original scoring system or <tt>25</tt> if you enable the new risk score system via the '''Use New Risk Score''' setting below. For more information, see [http://www.maxmind.com/app/web_services_score2 Web Services Score].
 ===Use New Risk Score===
-Maxmind have implemented a new riskScore system on a scale of 1-100. If you wish to use this scale in the MaxMind Fraud Risk Score field above, tick this box. [https://www.maxmind.com/en/riskscore More Information]
+Enable this to use MaxMind's newer [https://www.maxmind.com/en/riskscore risk score system] on a scale of 1-100.
 ===Do Not Send City===
-By default the module will compare the city name the client entered into the order form against Maxmind's list of world cities. If the provided city is not found in the list, the order will be rejected. However sometimes Maxmind's list may be incomplete or there may be multiple spellings of the same city which can result in this check rejecting legitimate orders. Tick this option to skip the city check.
-==Notes==
+Enable this to skip checking the city on orders against MaxMind's list of world cities.
-The score rating that you want to start blocking orders at is up to you but MaxMind recommend 2.5.  For more information, see [http://www.maxmind.com/app/web_services_score2 Web Services Score]
+By default, if the client's city is not in MaxMind's list, MaxMind will flag the order as fraud. However, sometimes Maxmind's list may be incomplete or there may be multiple spellings of the same city. In these cases, the check could reject legitimate orders.
 ==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.
+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 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'''.
+===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}}

Documentation