Merge pull request #603 from maxmind/greg/eng-4049

Add trackingToken to Device request object

Author: horgh

CHANGELOG.md

@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+4.2.0
+------------------
+
+* Added `trackingToken` to the `Device` request object. This is the token
+  generated by the
+  [Device Tracking Add-on](https://dev.maxmind.com/minfraud/track-devices)
+  for explicit device linking.
+
 4.1.0 (2026-01-20)
 ------------------
 

README.md

@@ -144,6 +144,7 @@ Transaction request = new Transaction.Builder(
             .acceptLanguage("en-US")
             .sessionAge(3600.6)
             .sessionId("foobar")
+            .trackingToken("abc123")
             .userAgent("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36")
             .build()
     ).account(

src/main/java/com/maxmind/minfraud/request/Device.java

@@ -13,13 +13,15 @@ public final class Device extends AbstractModel {
     private final String acceptLanguage;
     private final Double sessionAge;
     private final String sessionId;
+    private final String trackingToken;
 
     private Device(Device.Builder builder) {
         ipAddress = builder.ipAddress;
         userAgent = builder.userAgent;
         acceptLanguage = builder.acceptLanguage;
         sessionAge = builder.sessionAge;
         sessionId = builder.sessionId;
+        trackingToken = builder.trackingToken;
     }
 
     /**
@@ -32,6 +34,7 @@ public static final class Builder {
         String acceptLanguage;
         Double sessionAge;
         String sessionId;
+        String trackingToken;
 
         /**
          * Constructor for the {@code Device.Builder} class
@@ -100,6 +103,16 @@ public Device.Builder sessionId(String sessionId) {
             return this;
         }
 
+        /**
+         * @param trackingToken The tracking token generated by the Device Tracking Add-on
+         *                      for explicit device linking.
+         * @return The builder object.
+         */
+        public Device.Builder trackingToken(String trackingToken) {
+            this.trackingToken = trackingToken;
+            return this;
+        }
+
         /**
          * @return An instance of {@code Device} created from the fields set on this builder.
          */
@@ -140,6 +153,14 @@ public String sessionId() {
         return sessionId;
     }
 
+    /**
+     * @return The tracking token.
+     */
+    @JsonProperty("tracking_token")
+    public String trackingToken() {
+        return trackingToken;
+    }
+
     /**
      * @return The IP address used in the transaction.
      */

src/test/java/com/maxmind/minfraud/request/DeviceTest.java

@@ -61,4 +61,11 @@ public void testSessionId() {
         var device = new Builder(ip).sessionId(id).build();
         assertEquals(id, device.sessionId());
     }
+
+    @Test
+    public void testTrackingToken() {
+        var token = "abc123";
+        var device = new Builder(ip).trackingToken(token).build();
+        assertEquals(token, device.trackingToken());
+    }
 }

src/test/java/com/maxmind/minfraud/request/RequestTestHelper.java

@@ -53,6 +53,7 @@ private static Transaction makeTransaction(Email e) throws Exception {
                 .sessionAge(3600.5)
                 .sessionId("foobar")
                 .acceptLanguage("en-US,en;q=0.8")
+                .trackingToken("tst_abc123")
                 .build()
         )
             .event(

src/test/resources/test-data/full-request-email-md5.json

@@ -93,6 +93,7 @@
     "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36",
     "session_age": 3600.5,
     "session_id": "foobar",
-    "accept_language": "en-US,en;q=0.8"
+    "accept_language": "en-US,en;q=0.8",
+    "tracking_token": "tst_abc123"
   }
 }

src/test/resources/test-data/full-request.json

@@ -93,6 +93,7 @@
     "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36",
     "session_age": 3600.5,
     "session_id": "foobar",
-    "accept_language": "en-US,en;q=0.8"
+    "accept_language": "en-US,en;q=0.8",
+    "tracking_token": "tst_abc123"
   }
 }