MaxMind.MinFraud 5.0.0

Prefix Reserved
dotnet add package MaxMind.MinFraud --version 5.0.0                
NuGet\Install-Package MaxMind.MinFraud -Version 5.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MaxMind.MinFraud" Version="5.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MaxMind.MinFraud --version 5.0.0                
#r "nuget: MaxMind.MinFraud, 5.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MaxMind.MinFraud as a Cake Addin
#addin nuget:?package=MaxMind.MinFraud&version=5.0.0

// Install MaxMind.MinFraud as a Cake Tool
#tool nuget:?package=MaxMind.MinFraud&version=5.0.0                

.NET API for MaxMind minFraud Services

NuGet API Docs


This package provides an API for the MaxMind minFraud web services. This includes minFraud Score, Insights, and Factors. It also includes our minFraud Report Transaction API.

The legacy minFraud Standard and Premium services are not supported by this API.


This library works with .NET Framework version 4.6.1 and above and .NET Standard 2.0 or above.

This library depends on GeoIP2 and its dependencies.



We recommend installing this library with NuGet. To do this, type the following into the Visual Studio Package Manager Console:

install-package MaxMind.MinFraud


This API uses the async/await feature introduced in .NET 4.5 to provide non-blocking calls to the minFraud web services.

To use this API, first create a new WebServiceClient object. The constructor takes your MaxMind account ID and license key:

var client = new WebServiceClient(10, "LICENSEKEY");

To use the Sandbox web service instead of the production web service, you can provide the host argument:

var client = new WebServiceClient(
    accountId: 10, 
    licenseKey: "LICENSEKEY", 
    host: ""

You may also specify the fall-back locales, the host, or the timeout as optional parameters. See the API docs for more information.

This object is safe to share across threads. If you are making multiple requests, the object should be reused to so that new connections are not created for each request. Once you have finished making requests, you should dispose of the object to ensure the connections are closed and any resources are promptly returned to the system.

Making a minFraud Score, Insights, or Factors Request

Create a new Transaction object. This represents the transaction that you are sending to minFraud:

var transaction = new Transaction(
    device: new Device(
        ipAddress: System.Net.IPAddress.Parse(""),
        userAgent: "Mozilla/5.0 (X11; Linux x86_64)",
        acceptLanguage: "en-US,en;q=0.8"
        new Account(
            userId: "3132",
            username: "fred"

After creating the request object, send a non-blocking minFraud Score request by calling the ScoreAsync method using the await keyword from a method marked as async:

var score = await client.ScoreAsync(transaction);

A minFraud Insights request by calling the InsightsAsync method:

var insights = await client.InsightsAsync(transaction);

Or a minFraud Factors request by calling the FactorsAsync method:

var factors = await client.FactorsAsync(transaction);

If the request succeeds, a model object will be returned for the endpoint. If the request fails, an exception will be thrown.

See the API documentation for more details.

ASP.NET Core Usage

To use the web service API with HttpClient factory pattern as a Typed client you need to do the following:

  1. Add the following lines to Startup.cs ConfigureServices method:
// Configure to read configuration options from MinFraud section

// Configure dependency injection for WebServiceClient
  1. Add configuration in your appsettings.json with your account ID and license key.
  "MinFraud": {
    "AccountId": 10,
    "LicenseKey": "LICENSEKEY",
    "Timeout": TimeSpan.FromSeconds(5), // optional
    "Host": "" // optional
  1. Inject the WebServiceClient where you need to make the call and use it.
public class MinFraudController : ControllerBase
    private readonly WebServiceClient _minfraudClient;

    public MaxMindController(WebServiceClient minfraudClient)
        _minfraudClient = minfraudClient;

    public async Task<double?> RiskScore(Transaction transaction)
        var score = await _minfraudClient.ScoreAsync(transaction);

        return score.RiskScore;

Reporting a Transaction to MaxMind

If a transaction was scored incorrectly or you received a chargeback, you may report it to MaxMind. To do this, create a new TransactionReport object:

var report = new TransactionReport(
    ipAddress: IPAddress.Parse(""), 
    tag: TransactionReportTag.Chargeback,
    chargebackCode: "BL",
    maxmindId: "abcd1234",
    minfraudId: new Guid("01c25cb0-f067-4e02-8ed0-a094c580f5e4"),
    notes: "Suspicious account behavior",
    transactionId: "txn123");

A valid tag and at least one of the following are required parameters: ipAddress, maxmindId, minfraudId, transactionId.

Send the report by calling the ReportAsync method using the await keyword:

await client.ReportAsync(report);

The endpoint does not return any data and the method does not return a value. If there is an error, an exception will be thrown.


Thrown by the request models:

  • ArgumentException - Thrown when invalid data is passed to the model constructor.

Thrown by WebServiceClient method calls:

  • AuthenticationException - Thrown when the server is unable to authenticate the request, e.g., if the license key or account ID is invalid.
  • InsufficientFundsException - Thrown when your account is out of funds.
  • PermissionRequireException - Thrown when your account does not have permission to access the service.
  • InvalidRequestException - Thrown when the server rejects the request for another reason such as invalid JSON in the POST.
  • MinFraudException - Thrown when the server returns an unexpected response. This also serves as the base class for the above exceptions.
  • HttpException - Thrown when an unexpected HTTP error occurs such as an internal server error or other unexpected status code.


using MaxMind.MinFraud;
using MaxMind.MinFraud.Request;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

public class MinFraudExample
    static void Main()

    static public async Task MinFraudAsync()
        var transaction = new Transaction
            Device = new Device
                IPAddress = IPAddress.Parse(""),
                UserAgent = "Mozilla/5.0 (X11; Linux x86_64)",
                AcceptLanguage = "en-US,en;q=0.8",
                SessionAge = 3600.5,
                SessionId = "a333a4e127f880d8820e56a66f40717c"
            Event = new Event
                TransactionId = "txn3134133",
                ShopId = "s2123",
                Time = new DateTimeOffset(2014, 4, 12, 23, 20, 50, 52, new TimeSpan(0)),
                Type = EventType.Purchase
            Account = new Account
                UserId = "3132",
                Username = "fred"
            Email = new Email
                Address = "",
                Domain = "",
                HashAddress = false
            Billing = new Billing
                FirstName = "First",
                LastName = "Last",
                Company = "Company",
                Address = "101 Address Rd.",
                Address2 = "Unit 5",
                City = "City of Thorns",
                Region = "CT",
                Country = "US",
                Postal = "06510",
                PhoneNumber = "123-456-7890",
                PhoneCountryCode = "1"
            Shipping = new Shipping
                FirstName = "ShipFirst",
                LastName = "ShipLast",
                Company = "ShipCo",
                Address = "322 Ship Addr. Ln.",
                Address2 = "St. 43",
                City = "Nowhere",
                Region = "OK",
                Country = "US",
                Postal = "73003",
                PhoneNumber = "123-456-0000",
                PhoneCountryCode = "1",
                DeliverySpeed = ShippingDeliverySpeed.SameDay
            Payment = new Payment
                Processor = PaymentProcessor.Stripe,
                WasAuthorized = false,
                DeclineCode = "invalid number"
            CreditCard = new CreditCard
                IssuerIdNumber = "411111",
                BankName = "Bank of No Hope",
                BankPhoneCountryCode = "1",
                BankPhoneNumber = "123-456-1234",
                AvsResult = 'Y',
                CvvResult = 'N',
                Last4Digits = "7643",
                Token = "123456abc1234",
                Was3DSecureSuccessful = true
            CustomInputs = new CustomInputs.Builder
                { "float_input", 12.1d},
                { "integer_input", 3123},
                { "string_input", "This is a string input."},
                { "boolean_input", true},
            Order = new Order
                Amount = 323.21m,
                Currency = "USD",
                DiscountCode = "FIRST",
                AffiliateId = "af12",
                SubaffiliateId = "saf42",
                ReferrerUri = new Uri(""),
                IsGift = true,
                HasGiftMessage = false
            ShoppingCart = new List<ShoppingCartItem>
                new ShoppingCartItem
                    Category = "pets",
                    ItemId = "ad23232",
                    Quantity = 2,
                    Price = 20.43m
                new ShoppingCartItem
                    Category = "beauty",
                    ItemId = "bst112",
                    Quantity = 1,
                    Price = 100.00m

        // If you are making multiple requests, a single WebServiceClient
        // should be shared across requests to allow connection reuse. The
        // class is thread safe.
        // Replace "6" with your account ID and "ABCD567890" with your license
        // key.
        using (var client = new WebServiceClient(6, "ABCD567890"))
            // Use `InsightsAsync` if querying Insights
            var score = await client.ScoreAsync(transaction);


Please report all issues with this code using the GitHub issue tracker.

If you are having an issue with the minFraud service that is not specific to the client API, please see our support page.


Patches and pull requests are encouraged. Please include unit tests whenever possible.


This API uses Semantic Versioning.

This software is Copyright (c) 2015-2024 by MaxMind, Inc.

This is free software, licensed under the Apache License, Version 2.0.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0 131 7/8/2024
4.3.0 2,929 4/16/2024
4.2.0 10,004 12/6/2023
4.1.0 54,736 3/28/2022
4.0.0 2,573 2/7/2022
3.3.0 1,458 1/27/2022
3.2.0 12,430 8/27/2021
3.1.0 11,191 2/2/2021
3.0.0 26,804 11/24/2020
2.9.0 17,739 10/14/2020
2.8.0 20,096 9/25/2020
2.7.0 1,534 7/31/2020
2.6.0 44,810 6/19/2020
2.5.0 36,846 4/6/2020
2.4.0 1,859 3/26/2020
2.3.0 2,612 2/21/2020
2.2.0 9,298 12/10/2019
2.1.0 13,290 8/12/2019
2.0.0 98,468 4/11/2018
1.6.0 5,885 1/22/2018
1.5.0 1,203 11/1/2017
1.4.1 8,594 7/21/2017
1.4.0 1,037 7/7/2017
1.3.0 11,875 11/22/2016
1.2.1 1,088 11/21/2016
1.2.0 1,070 11/14/2016
1.1.0 1,059 10/11/2016
1.0.0 5,908 9/16/2016
0.7.1 1,059 8/8/2016
0.7.0 1,102 8/1/2016
0.7.0-beta1 1,192 6/15/2016
0.6.0 1,364 6/8/2016
0.5.0 1,118 5/23/2016
0.4.0-beta2 846 1/29/2016
0.4.0-beta1 802 1/28/2016
0.3.1 1,327 12/4/2015
0.3.0 1,199 12/4/2015
0.2.0 1,205 9/23/2015
0.2.0-beta1 904 9/10/2015
0.1.1-beta1 904 6/30/2015
0.1.0 1,140 6/29/2015
0.0.1 2,309 6/18/2015