Changes to the minFraud web services are documented in our release notes.
We encourage you to use one our minFraud client APIs if possible. APIs are available in the following languages:
|Language/Platform||Documentation||Package Repository||Version Control|
|Java||Documentation||Maven Central Repository||GitHub|
|PHP||Documentation||Composer / Source||GitHub|
The client APIs take care of formatting requests and parsing the response for you.
If you are using our minFraud transaction fraud detection service, we also encourage you to use our chargeback reporting service. By reporting instances of fraud to us, you can help us tune our algorithms further, reducing fraud even more in the future.
If an API for your language is not available, you can use the “raw” API detailed below.
The HTTP API requires you to pass a set of parameters as an HTTP GET or POST. Results are returned in a simple text format documented below.
The URI for this service is https://minfraud.maxmind.com/app/ccv2r.
The minfraud.maxmind.com hostname automatically picks the data center geographically closest to you. In some cases, this data center may not be the one that provides you with the best service. You can explicitly try the minfraud-us-east.maxmind.com and minfraud-us-west.maxmind.com hostnames to see which one provides the best performance for you.
The minFraud API accepts input in a query string or as a form post (application/x-www-form-urlencoded). It accepts the following fields. The name of each field should be used as the query string or form field name. Field names are case-sensitive.
The length of the data passed to us does not matter for most fields. We will truncate inputs as needed. However, for a few fields the length is important, and this is noted in the table below.
The following fields are required.
|i||string||The IP address of the customer placing the order. This should be passed as a string like “126.96.36.199″ or “2001:db8::2:1″.|
|city||string||The billing city for the customer.|
|region||string||The billing region/state for the customer.|
|postal||string||The billing postal (zip) code for the customer.|
|country||string||The billing country for the customer. This can be passed as the full country name or as an ISO 3166 code.|
|license_key||string||Your MaxMind license key.|
These fields are used to check against our database of known high risk shipping addresses.
You should only pass these fields when shipping physical goods.
|shipAddr||string||The shipping street address.|
|shipCity||string||The shipping address city.|
|shipRegion||string||The shipping address region/state.|
|shipPostal||string||The shipping address postal (zip) code.|
|shipCountry||string||The shipping address country.|
Some of these fields are MD5 hash fields. Such fields should be passed as an MD5 hash in hex form. Always lower-case the input before hashing. Do not use any salt when hashing these inputs.
|domain||string||The domain for the user’s email address. This field should not be hashed.|
|custPhone||string||The customer’s phone number, including area code and local exchange. This is used to verify that the customer’s phone number is in the same billing location as the cardholder. Most formats are acceptable. We strip out all non-numeric characters from the input.|
|emailMD5||string (32)||An MD5 hash of the user’s email address in ASCII encoding.|
|usernameMD5||string (32)||An MD5 hash of the user’s username in ASCII encoding.|
|passwordMD5||string (32)||An MD5 hash of the user’s password in ASCII encoding.|
These fields are used to verify that the customer is in possession of the credit card.
|bin||string||The credit card BIN number. This is the first 6 digits of the credit card number. It identifies the issuing bank.|
|binName||string||The name of the bank which issued the credit card, based on the BIN number. This is used to verify that cardholder is in possession of credit card. You must set the bin field if you set this one.|
|binPhone||string||The customer service phone number listed on the back of the credit card. This is used to verify that cardholder is in possession of credit card. You must set the bin field if you set this one.|
These fields are used to link together fraudulent orders from the same browser across multiple proxies or credit card numbers.
|sessionID||string||Your internal session ID.|
|user_agent||string||The User-Agent HTTP header.|
|accept_language||string||The Accept-Language HTTP header.|
These fields provide additional information about the transaction.
|txnID||string||Your internal transaction ID for the order. We can use this to locate a specific transaction in our logs, and it will also show up in email alerts and notifications from us to you.|
|order_amount||decimal (20, 3)||The customer’s order amount.|
|order_currency||string (3)||The currency used for the customer’s order as an ISO 4217 code.|
|shopID||string||Your internal ID for the shop, affiliate, or merchant this order is coming from.|
The transaction type. This can be set to one of the following strings:
The lead, survey, and sitereg types are used for non-purchase transactions.
To provide these fields you must run the AVS and/or CVV checks before calling minFraud.
The AVS check result, as returned to you by the credit card processor. The minFraud service supports the standard AVS codes.
|cvv_result||enum||The CVV check result. This should be either “N” or “Y”. Do not pass the CVV code itself.|
This can be set to either “standard” or “premium”. By default, we use the highest level of service available for your account.
If you have both the premium and standard minFraud service, you can choose to use the standard service to save on costs.
The end user’s IP address, as forwarded by a transparent proxy. Transparent proxies set the HTTP headers X-Forwarded-For or Client-IP to the IP address of the end user. This should be passed as a string like “188.8.131.52″ or “2001:db8::2:1″.
Note that the forwarded IP should not be set in the i field. We check that the IP address passed to the i input field is a legitimate transparent proxy before using the value in the forwardedIP input field.
The minFraud service returns its output as a set of fields separated by semicolons (;). Each field consists of a name and value separated by an equals sign (=). The field values are not escaped, but will never contain a semicolon or equals sign.
All strings are returned in the ISO-8859-1 encoding. This encoding is also referred to as latin1.
Here is an example of the output with just a few fields:
The API version column indicates in what version of the API a field was added. You can explicitly ask for responses in older API formats. By default, all new users will receive responses for the version that was current when they signed up for the service. The latest version is 1.3.
|Name||Type (length)||Description||API version|
|riskScore||decimal||This field contains the risk score, from 0.01 to 100. A higher score indicates a higher risk of fraud. For example, a score of 20 indicates a 20% chance that a transaction is fraudulent. We never return a risk score of 0, since all transactions have the possibility of being fraudulent.||1.1|
|score||decimal||This field has been deprecated, is not supported, and is no longer present in API version 1.3.||1.0|
|explanation||string||This field has been deprecated, is not supported, and is no longer present in API version 1.3. This is a brief explanation of the score (not the riskScore).||1.0|
These fields are based on the correspondance between the user’s IP address and the location information they provided.
|countryMatch||enum||This field can be either Yes or No. It indicates whether the country of the IP address matched the billing address country. A mismatch indicates a higher risk of fraud.||1.0|
|highRiskCountry||enum||This field can be either Yes or No. It indicates whether the country is one that MaxMind considers to be especially risky, such as Ghana, Nigeria, or Vietnam.||1.0|
|distance||integer||The distance from the IP address location to the billing location, in kilometers. A higher distance indicates a higher risk of fraud.||1.0|
|ip_accuracyRadius||integer||The radius in kilometers around the specified location where the IP address is likely to be.||1.2|
|ip_city||string||The city or town name associated with the IP address. See our list of cities to see all the possible return values. This list is updated on a regular basis.||1.0|
For the US and Canada, we return an ISO-3166-2 code. In addition to the standard ISO codes, we may also return one of the following:
We return a FIPS code for all other countries.
We provide a CSV file which maps our region codes to region names. The columns are ISO country code, region code (FIPS or ISO), and the region name.
|ip_regionName||string||The region name associated with the IP address.||1.2|
|ip_postalCode||string||The postal code associated with the IP address. These are available for some IP addresses in Australia, Canada, France, Germany, Italy, Spain, Switzerland, United Kingdom, and the US. We return the first 3 characters for Canadian postal codes. We return the the first 2-4 characters (outward code) for postal codes in the United Kingdom.||1.2|
|ip_metroCode||integer||The metro code associated with the IP address. These are only available for IP addresses in the US. MaxMind returns the same metro codes as the Google AdWords API.||1.2|
|ip_areaCode||string||The telephone area code associated with the IP address. These are only available for IP addresses in the US. This output is deprecated, and may not reflect newer area codes.||1.2|
A two-character ISO 3166-1 country code for the country associated with the IP address. In addition to the standard codes, we may also return one of the following:
The US country code is returned for IP addresses associated with overseas US military bases.
|ip_countryName||string||The country name associated with the IP address.||1.2|
A two-character code for the continent associated with the IP address. The possible codes are:
|ip_latitude||decimal||The latitude associated with the IP address. The latitude and longitude are near the center of the most granular location value returned: postal code, city, region, or country.||1.0|
|ip_longitude||decimal||The longitude associated with the IP address.||1.0|
|ip_timeZone||string||The time zone associated with the IP address. Time zone names are taken from the IANA time zone database. See the list of possible values.||1.2|
|ip_asnum||string||The autonomous system number associated with the IP address.||1.2|
The user type associated with the IP address. This will be one of the following values.
The network speed associated with the IP address. This can be one of the following values:
|ip_domain||string||The second level domain associated with the IP address. This will be something like “example.com” or “example.co.uk”, not “foo.example.com”.||1.2|
|ip_isp||string||The name of the ISP associated with the IP address.||1.0|
|ip_org||string||The name of the organization associated with the IP address.||1.0|
|ip_cityConf||decimal||A value from 0-100 representing our confidence that the city is correct.||1.2|
|ip_regionConf||decimal||A value from 0-100 representing our confidence that the region is correct.||1.2|
|ip_postalConf||decimal||A value from 0-100 representing our confidence that the postal code is correct.||1.2|
|ip_countryConf||decimal||A value from 0-100 representing our confidence that the country is correct.||1.2|
These fields provide information about whether or not the user’s IP address is a proxy, and if so, what type of proxy.
|anonymousProxy||enum||This field can be either Yes or No. It indicates whether the user’s IP address is an anonymous proxy. An anonymous proxy indicates a high risk of fraud.||1.0|
|proxyScore||decimal||A score from 0.00-4.00 indicating the likelihood that the user’s IP address is an open proxy.
|isTransProxy||enum||This field can be either Yes or No. It indicates whether the user’s IP address is in our database of known transparent proxy servers. This is only returned if the forwardedIP field was set in the input.||1.0|
|ip_corporateProxy||enum||This field can be either Yes or No. It indicates whether the user’s IP address is a known corporate proxy.||1.2|
These fields provide information about the email and login info that was provided in the input.
|freeMail||enum||This field can be either Yes or No. It indicates whether the user’s email address is from a free email provider. Note that this will be set to “No” if no domain is passed in the input.||1.0|
|carderEmail||enum||This field can be either Yes or No. It indicates whether the user’s email address is in a database of known high risk emails.||1.0|
|highRiskUsername||This field does not return useful data. It will be removed in a future release.||1.0|
|highRiskPassword||This field does not return useful data. It will be removed in a future release.||1.0|
These fields provide information about the user’s credit card and its issuing bank.
This field can be either Yes, No, NotFound, or NA It indicates whether the credit card’s bank is in the same country as the user’s billing address.
The NotFound response means that we could not find a match for the provided bin input field. The NA response means that you did not provide a bin in the input.
|binCountry||string (2)||The two letter ISO 3166 country code for the bank. This is available for approximately 99% of all BIN numbers. This field is returned for premium service level queries. For standard service level queries the field is only returned if the binMatch is Yes.||1.1|
This field can be either Yes, No, NotFound, or NA It indicates whether the credit card’s bank name matches the binName input field.
The NotFound response means that we could not find a match for the provided bin input field. The NA response means that you did not provide a binName in the input.
|binName||string||The name of the bank which issued the credit card. This is available for approximately 96% of all BIN numbers. This field is only returned for premium service level queries.||1.1|
This field can be either Yes, No, NotFound, or NA It indicates whether the credit card’s bank name matches the binPhone input field.
The NotFound response means that we could not find a match for the provided bin input field. The NA response means that you did not provide a binPhone in the input.
|binPhone||string||The phone number of the bank which issued the credit card. This is available for approximately 75% of all BIN numbers. In some cases the phone number we return may be out of date. This field is only returned for premium service level queries.||1.1|
|prepaid||enum||This field can be either Yes or No. This indicates whether the card is a prepaid or gift card. If no bin input was provided, this field will be left blank.||1.3|
These fields provide information the user’s phone and address.
This field can be either Yes, No, or NotFound. This indicates whether the customer’s phone number is in the billing address’s postal code.
The No response means that phone number may be in a different area, or it is not listed in our database. The NotFound response indicates that the phone number prefix is not in our database.
Currently we only return information about US phone numbers. For all other countries, this field will be left blank.
|shipForward||enum||This field can be either Yes, No, or NA. This indicates whether the customer’s shipping address is in a database of known high risk shipping addresses. The NA response indicates that we could not parse the shipping address.||1.0|
|cityPostalMatch||enum||This field can be either Yes or No. This indicates whether the customer’s billing city and state match their postal code. This is currently only available for US addresses. For addresses outside the US, this field is empty.||1.0|
|shipCityPostalMatch||enum||This field can be either Yes or No. This indicates whether the customer’s shipping city and state match their postal code. This is currently only available for US addresses. For addresses outside the US, this field is empty.||1.0|
These fields provide information about your MaxMind account.
|queriesRemaining||integer||This is the number of minFraud queries remaining in your account.||1.0|
|maxmindID||string (8)||This is a unique eight character string identifying this minFraud request. Please use this ID in bug reports or support requests to MaxMind so that we can easily identify a particular request.||1.0|
|minfraud_version||string||This returns the API version that was used for this request.||1.0|
|service_level||enum||This returns the service level that was used for this request. This can be either standard or premium.||1.0|
If there was an error or warning with this request, this field contains an error code string.
The possible error codes are:
The possible warning codes are:
In addition to the HTTP API, MaxMind also offers a SOAP API for minFraud. Download one of the WSDL files below. We recommend using the latest version if you can.