Sync OpenAPI Schema (17700) by fingerprint-dx-team-actions-runner[bot] · Pull Request #397 · fingerprintjs/fingerprint-pro-server-api-openapi

fingerprint-dx-team-actions-runner · 2026-06-24T16:50:14Z

This PR automatically updates the OpenAPI schema.

Changes

88 file(s) modified, 4 file(s) added

Modified files

schemas/components/schemas/EdgeRequest.yaml
schemas/components/schemas/Event.yaml
schemas/components/schemas/EventSearch.yaml
schemas/components/schemas/EventUpdate.yaml
schemas/components/schemas/error/Error.yaml
schemas/components/schemas/identification/BrowserDetails.yaml
schemas/components/schemas/identification/BundleId.yaml
schemas/components/schemas/identification/ClientReferrer.yaml
schemas/components/schemas/identification/Identification.yaml
schemas/components/schemas/identification/IdentificationConfidence.yaml
schemas/components/schemas/identification/IpAddress.yaml
schemas/components/schemas/identification/PackageName.yaml
schemas/components/schemas/identification/Proximity.yaml
schemas/components/schemas/identification/SupplementaryIDHighRecall.yaml
schemas/components/schemas/identification/Tags.yaml
schemas/components/schemas/identification/Url.yaml
schemas/components/schemas/identification/UserAgent.yaml
schemas/components/schemas/platform/EnvironmentId.yaml
schemas/components/schemas/platform/EventId.yaml
schemas/components/schemas/platform/Integration.yaml
schemas/components/schemas/platform/LinkedId.yaml
schemas/components/schemas/platform/RequestHeaderModifications.yaml
schemas/components/schemas/platform/RuleActionBody.yaml
schemas/components/schemas/platform/RuleActionHeaderField.yaml
schemas/components/schemas/platform/RuleExpression.yaml
schemas/components/schemas/platform/RuleId.yaml
schemas/components/schemas/platform/RulesetId.yaml
schemas/components/schemas/platform/SDK.yaml
schemas/components/schemas/platform/StatusCode.yaml
schemas/components/schemas/platform/Timestamp.yaml
schemas/components/schemas/platform/webhook/TriggeredBy.yaml
schemas/components/schemas/smartsignals/BotInfo.yaml
schemas/components/schemas/smartsignals/BotInfoCategory.yaml
schemas/components/schemas/smartsignals/BotInfoConfidence.yaml
schemas/components/schemas/smartsignals/BotInfoIdentity.yaml
schemas/components/schemas/smartsignals/BotType.yaml
schemas/components/schemas/smartsignals/FactoryReset.yaml
schemas/components/schemas/smartsignals/Geolocation.yaml
schemas/components/schemas/smartsignals/IPBlockList.yaml
schemas/components/schemas/smartsignals/IPInfo.yaml
schemas/components/schemas/smartsignals/IPInfoV4.yaml
schemas/components/schemas/smartsignals/IPInfoV6.yaml
schemas/components/schemas/smartsignals/Labels.yaml
schemas/components/schemas/smartsignals/ProxyDetails.yaml
schemas/components/schemas/smartsignals/ProxyMLScore.yaml
schemas/components/schemas/smartsignals/RawDeviceAttributes.yaml
schemas/components/schemas/smartsignals/SuspectScore.yaml
schemas/components/schemas/smartsignals/TamperingDetails.yaml
schemas/components/schemas/smartsignals/TamperingMlScore.yaml
schemas/components/schemas/smartsignals/Velocity.yaml
schemas/components/schemas/smartsignals/VelocityData.yaml
schemas/components/schemas/smartsignals/VirtualMachineMLScore.yaml
schemas/components/schemas/smartsignals/VpnMethods.yaml
schemas/components/schemas/smartsignals/VpnOriginCountry.yaml
schemas/components/schemas/smartsignals/VpnOriginTimezone.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Architecture.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Audio.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/BatteryLevel.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Canvas.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/ColorDepth.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/DateTimeLocale.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/DeviceManufacturer.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/DeviceMemory.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/DeviceModel.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Emoji.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/FontHash.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/FontPreferences.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Fonts.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/HardwareConcurrency.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Languages.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Math.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Oscpu.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Platform.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Plugins.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/ScreenResolution.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Timezone.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/TimezoneOffset.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/TouchSupport.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/Vendor.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/WebGlBasics.yaml
schemas/components/schemas/smartsignals/raw_device_attributes/WebGlExtensions.yaml
schemas/paths/event.yaml
schemas/paths/events.yaml
schemas/paths/examples/events/get_event_200.json
schemas/paths/examples/events/get_event_ruleset_200.json
schemas/paths/examples/events/get_event_with_bot_info_200.json
schemas/paths/examples/events/search/get_event_search_200.json
schemas/paths/visitors.yaml

Added files

schemas/components/schemas/identification/Device.yaml
schemas/components/schemas/identification/Os.yaml
schemas/components/schemas/identification/OsVersion.yaml
schemas/components/schemas/smartsignals/VpnMLScore.yaml

Note for reviewers: Please review the schema changes.
You likely need to manually add a changeset file to this branch before merging.

fingerprint-dx-team-actions-runner · 2026-06-24T16:50:18Z

✅The changes have been finalized. This PR is ready for review.

changeset-bot · 2026-06-24T16:50:19Z

⚠️ No Changeset found

Latest commit: 684a9b9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2026-06-24T16:50:44Z

Schema Diff vs Published Schemas

Generated at: 2026-06-25T16:49:16.344Z
Published source: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas
Compared schemas: 8
Changed schemas: 3

`fingerprint-server-api-v4-normalized.yaml`

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-normalized.yaml
Summary: +20 added, -9 removed, ~15 modified

Added elements (20)

/components/schemas/Canvas/required
/components/schemas/Emoji/required
/components/schemas/EventUpdate/properties/tags/required
/components/schemas/EventUpdate/required
/components/schemas/FontPreferences/required
/components/schemas/Geolocation/required
/components/schemas/IPBlockList/required
/components/schemas/IPInfo/required
/components/schemas/Integration/properties/subintegration/required
/components/schemas/Integration/required
/components/schemas/Plugins/items/properties/mimeTypes/items/required
/components/schemas/RawDeviceAttributes/required
/components/schemas/RequestHeaderModifications/required
/components/schemas/Tags/required
/components/schemas/TamperingDetails/required
/components/schemas/TouchSupport/required
/components/schemas/Velocity/required
/components/schemas/VpnMethods/required
/components/schemas/WebGlBasics/required
/components/schemas/WebGlExtensions/required

Removed elements (9)

/components/schemas/BatteryLevel/example
/components/schemas/DeviceMemory/example
/components/schemas/Fonts/example
/paths/~1events/get/parameters/0/schema/default
/paths/~1events/get/parameters/0/schema/example
/paths/~1events/get/parameters/18/schema/example
/paths/~1events/get/parameters/19/schema/example
/paths/~1events/get/parameters/20/schema/example
/paths/~1events/get/parameters/21/schema/example

Modified elements (15)

/components/schemas/BundleId/description
/components/schemas/ClientReferrer/description
/components/schemas/EnvironmentId/description
/components/schemas/EventId/description
/components/schemas/EventUpdate/properties/linked_id/description
/components/schemas/Integration/properties/name/description
/components/schemas/Integration/properties/subintegration/properties/name/description
/components/schemas/Integration/properties/subintegration/properties/version/description
/components/schemas/Integration/properties/version/description
/components/schemas/PackageName/description
/components/schemas/SDK/properties/version/description
/components/schemas/Url/description
/components/schemas/UserAgent/description
/paths/~1events/get/parameters/0/description
/paths/~1events/get/parameters/1/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -247,17 +247,16 @@
           schema:
             type: integer
             format: int32
             minimum: 1
             maximum: 100
-            default: 10
-            example: 10
           description: >
-            Maximum number of events to return. Results are selected from the
-            time range (`start`, `end`), ordered by `reverse`, then truncated to
-            provided `limit` size. So `reverse=true` returns the oldest
-            N=`limit` events, otherwise the newest N=`limit` events.
+            Maximum number of events to return. Defaults to 10 when omitted.
+            Results are selected from the time range (`start`, `end`), ordered
+            by `reverse`, then truncated to provided `limit` size. So
+            `reverse=true` returns the oldest N=`limit` events, otherwise the
+            newest N=`limit` events.
         - name: pagination_key
           in: query
           schema:
             type: string
           description: >
@@ -275,11 +274,12 @@
 
             1. First request, returning most recent 100 events: `GET
             api-base-url/events?limit=100`
 
             2. Use `response.pagination_key` to get the next page of results:
-            `GET api-base-url/events?limit=100&pagination_key=1740815825085`
+            `GET
+            api-base-url/events?limit=100&pagination_key=S9rgMMUb4z3X5t5pr_tSgoSZlmyF0O8X7kCV2m981-iY1LmRTjraa1rTk3L-hQExnDWCi0RA-zAIjaVSTNO2AN2eqQWgzT0RjbieMxRfSdkM-HmOhdOgdQvYfPG3vqU1DJKh4Q`
         - name: visitor_id
           in: query
           schema:
             type: string
           description: >
@@ -481,11 +481,10 @@
             default of `now` for `end`/`end_date_time` — adjust it separately if
             needed.
           schema:
             type: integer
             format: int64
-            example: 1767225600000
           x-parameter-alias: start_date_time
         - name: start_date_time
           in: query
           description: >-
             Include events that happened after this point (with timestamp
@@ -494,11 +493,10 @@
             not the default of `now` for `end`/`end_date_time` — adjust it
             separately if needed. This parameter is an alias for `start`.
           schema:
             type: string
             format: date-time
-            example: '2026-01-01T00:00:00Z'
           x-aliased-parameter-name: start
         - name: end
           in: query
           description: >-
             Include events that happened before this point (with timestamp less
@@ -506,11 +504,10 @@
             to now. Setting `end` does not change the default of `7 days ago`
             for `start`/`start_date_time` — adjust it separately if needed.
           schema:
             type: integer
             format: int64
-            example: 1769903999000
           x-parameter-alias: end_date_time
         - name: end_date_time
           in: query
           description: >-
             Include events that happened before this point (with timestamp less
@@ -519,11 +516,10 @@
             of `7 days ago` for `start`/`start_date_time` — adjust it separately
             if needed. This parameter is an alias for `end`.
           schema:
             type: string
             format: date-time
-            example: '2026-01-31T23:59:59Z'
           x-aliased-parameter-name: end
         - name: reverse
           in: query
           schema:
             type: boolean
@@ -1105,10 +1101,11 @@
             - medium
             - high
           description: Confidence level of the bot identification.
     Geolocation:
       type: object
+      required: []
       properties:
         accuracy_radius:
           type: integer
           minimum: 0
           description: >-
@@ -1204,10 +1201,11 @@
     IPInfo:
       type: object
       description: >-
         Details about the request IP address. Has separate fields for v4 and v6
         IP address versions.
+      required: []
       properties:
         v4:
           $ref: '#/components/schemas/IPInfoV4'
         v6:
           $ref: '#/components/schemas/IPInfoV6'
@@ -1270,10 +1268,11 @@
         A confidence rating for the VPN detection result — "low", "medium", or
         "high". Depends on the combination of results returned from all VPN
         detection methods.
     VpnMethods:
       type: object
+      required: []
       properties:
         timezone_mismatch:
           type: boolean
           x-platforms:
             - android
@@ -1429,12 +1428,11 @@
           $ref: '#/components/schemas/Error'
     EventId:
       type: string
       description: >
         Unique identifier of the user's request. The first portion of the
-        event_id is a unix epoch milliseconds timestamp For example:
-        `1758130560902.8tRtrH`
+        event_id is a unix epoch milliseconds timestamp.
     Timestamp:
       description: Timestamp of the event with millisecond precision in Unix time.
       type: integer
       format: int64
     IncrementalIdentificationStatus:
@@ -1455,36 +1453,37 @@
     LinkedId:
       type: string
       description: A customer-provided id that was sent with the request.
     EnvironmentId:
       type: string
-      description: |
-        Environment Id of the event. For example: `ae_47abaca3db2c7c43`
+      description: Environment Id of the event.
     Suspect:
       type: boolean
       description: >-
         Field is `true` if you have previously set the `suspect` flag for this
         event using the [Server API Update event
         endpoint](https://docs.fingerprint.com/reference/server-api-v4-update-event).
     Integration:
       type: object
+      required: []
       properties:
         name:
           type: string
-          description: The name of the specific integration, e.g. "fingerprint-pro-react".
+          description: The name of the specific integration.
         version:
           type: string
-          description: The version of the specific integration, e.g. "3.11.10".
+          description: The version of the specific integration.
         subintegration:
           type: object
+          required: []
           properties:
             name:
               type: string
-              description: The name of the specific subintegration, e.g. "preact".
+              description: The name of the specific subintegration.
             version:
               type: string
-              description: The version of the specific subintegration, e.g. "10.21.0".
+              description: The version of the specific subintegration.
     SDK:
       type: object
       description: Contains information about the SDK used to perform the request.
       required:
         - platform
@@ -1498,13 +1497,11 @@
             - ios
             - unknown
           description: Platform of the SDK used for the identification request.
         version:
           type: string
-          description: >
-            Version string of the SDK used for the identification request. For
-            example: `"3.12.1"`
+          description: Version string of the SDK used for the identification request.
         integrations:
           type: array
           items:
             $ref: '#/components/schemas/Integration'
     Replayed:
@@ -1614,33 +1611,30 @@
       type: object
       description: >-
         A customer-provided value or an object that was sent with the
         identification request or updated later.
       additionalProperties: true
+      required: []
     Url:
       type: string
-      description: >
-        Page URL from which the request was sent. For example
-        `https://example.com/`
+      description: Page URL from which the request was sent.
     BundleId:
       type: string
       description: >
         Bundle Id of the iOS application integrated with the Fingerprint SDK for
-        the event. For example: `com.foo.app`
+        the event.
     PackageName:
       type: string
       description: >
         Package name of the Android application integrated with the Fingerprint
-        SDK for the event. For example: `com.foo.app`
+        SDK for the event.
     IpAddress:
       type: string
       description: IP address of the requesting browser or bot.
     UserAgent:
       type: string
-      description: >
-        User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1;
-        Win64; x64) ....`
+      description: User Agent of the client.
     Device:
       type: string
       description: >
         Device model or family extracted from the user agent string (e.g.
         `iPhone`, `Generic Smartphone`, `Desktop`). On web, this field is also
@@ -1661,12 +1655,11 @@
       type: string
       description: >
         Client Referrer field corresponds to the `document.referrer` field
         gathered during an identification request. The value is an empty string
         if the user navigated to the page directly (not through a link, but, for
-        example, by using a bookmark) For example:
-        `https://example.com/blog/my-article`
+        example, by using a bookmark).
     BrowserDetails:
       type: object
       required:
         - browser_name
         - browser_full_version
@@ -1786,10 +1779,11 @@
         * `true` - Frida detected
 
         * `false` - No signs of Frida or the client is not a mobile device.
     IPBlockList:
       type: object
+      required: []
       properties:
         email_spam:
           type: boolean
           description: IP address was part of a known email spam attack (SMTP).
         attack_source:
@@ -1881,10 +1875,11 @@
     RequestHeaderModifications:
       type: object
       description: >-
         The set of header modifications to apply, in the following order:
         remove, set, append.
+      required: []
       properties:
         remove:
           type: array
           description: The list of headers to remove.
           items:
@@ -2039,10 +2034,11 @@
         Values close to 1 signify higher confidence and we consider anything
         above the threshold of 0.8 to be actionable (the result and
         anti_detect_browser fields conveniently captures that fact)
     TamperingDetails:
       type: object
+      required: []
       properties:
         anomaly_score:
           type: number
           format: double
           minimum: 0
@@ -2141,10 +2137,11 @@
 
         All will not necessarily be returned in a response, some may be omitted
         if the 
 
         associated event does not have the required data, such as a linked_id.
+      required: []
       properties:
         distinct_ip:
           $ref: '#/components/schemas/VelocityData'
         distinct_linked_id:
           $ref: '#/components/schemas/VelocityData'
@@ -2232,10 +2229,11 @@
       type: object
       description: >
         Baseline measurement of canonical fonts rendered on the device. Numeric
         width metrics, in CSS pixels, for the canonical fonts collected by the
         agent.
+      required: []
       properties:
         default:
           type: number
           format: double
         serif:
@@ -2257,10 +2255,11 @@
           type: number
           format: double
     Emoji:
       type: object
       description: Bounding box metrics describing how the emoji glyph renders.
+      required: []
       properties:
         font:
           type: string
           description: Font family reported by the browser when drawing the emoji.
         width:
@@ -2290,27 +2289,22 @@
     Fonts:
       type: array
       description: List of fonts detected on the device.
       items:
         type: string
-      example:
-        - Arial Unicode MS
-        - Gill Sans
-        - Helvetica Neue
-        - Menlo
     DeviceMemory:
       type: integer
       format: int32
       minimum: 0
-      example: 8
       description: Rounded amount of RAM in gigabytes.
     Timezone:
       type: string
       description: Timezone identifier detected on the client.
     Canvas:
       type: object
       description: Canvas fingerprint containing winding flag plus geometry/text hashes.
+      required: []
       properties:
         winding:
           type: boolean
         geometry:
           type: string
@@ -2329,10 +2323,11 @@
         items:
           type: string
     WebGlExtensions:
       type: object
       description: Hashes of WebGL context attributes and extension support.
+      required: []
       properties:
         context_attributes:
           type: string
         parameters:
           type: string
@@ -2347,10 +2342,11 @@
           items:
             type: string
     WebGlBasics:
       type: object
       description: Render and vendor strings reported by the WebGL context.
+      required: []
       properties:
         version:
           type: string
         vendor:
           type: string
@@ -2371,10 +2367,11 @@
         type: integer
         format: int32
     TouchSupport:
       type: object
       description: Browser-reported touch capabilities.
+      required: []
       properties:
         touch_event:
           type: boolean
         touch_start:
           type: boolean
@@ -2450,10 +2447,11 @@
             type: string
           mimeTypes:
             type: array
             items:
               type: object
+              required: []
               properties:
                 type:
                   type: string
                 suffixes:
                   type: string
@@ -2482,11 +2480,10 @@
     BatteryLevel:
       type: integer
       format: int32
       minimum: 0
       maximum: 100
-      example: 75
       description: >-
         Battery charge level as a percentage (0-100). Available only for Android
         and iOS devices.
     BatteryLowPowerMode:
       type: boolean
@@ -2497,10 +2494,11 @@
       type: object
       description: >
         A curated subset of raw browser/device attributes that the API surface
         exposes. Each property contains a value or object with the data for the
         collected signal.
+      required: []
       properties:
         font_preferences:
           $ref: '#/components/schemas/FontPreferences'
         emoji:
           $ref: '#/components/schemas/Emoji'
@@ -2919,20 +2917,22 @@
             - browser
             - ios
             - android
     EventUpdate:
       type: object
+      required: []
       properties:
         linked_id:
           type: string
-          description: Linked Id value to assign to the existing event
+          description: Linked ID value to assign to the existing event
         tags:
           type: object
           description: >-
             A customer-provided value or an object that was sent with the
             identification request or updated later.
           additionalProperties: true
+          required: []
         suspect:
           type: boolean
           description: Suspect flag indicating observed suspicious or fraudulent event
           x-go-force-pointer: true
     EventSearch:

`fingerprint-server-api-v4-with-examples.yaml`

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-with-examples.yaml
Summary: +185 added, -9 removed, ~16 modified

Added elements (185)

/components/schemas/Architecture/examples
/components/schemas/Audio/examples
/components/schemas/BatteryLevel/examples
/components/schemas/BotInfo/properties/provider_url/examples
/components/schemas/BotType/examples
/components/schemas/BrowserDetails/properties/browser_full_version/examples
/components/schemas/BrowserDetails/properties/browser_major_version/examples
/components/schemas/BrowserDetails/properties/browser_name/examples
/components/schemas/BrowserDetails/properties/device/examples
/components/schemas/BrowserDetails/properties/os/examples
/components/schemas/BrowserDetails/properties/os_version/examples
/components/schemas/BundleId/examples
/components/schemas/Canvas/properties/geometry/examples
/components/schemas/Canvas/properties/text/examples
/components/schemas/Canvas/required
/components/schemas/ClientReferrer/examples
/components/schemas/ColorDepth/examples
/components/schemas/DateTimeLocale/examples
/components/schemas/Device/examples
/components/schemas/DeviceManufacturer/examples
/components/schemas/DeviceMemory/examples
/components/schemas/DeviceModel/examples
/components/schemas/EdgeRequest/properties/headers/items/properties/name/examples
/components/schemas/EdgeRequest/properties/headers/items/properties/value/examples
/components/schemas/Emoji/properties/bottom/examples
/components/schemas/Emoji/properties/font/examples
/components/schemas/Emoji/properties/height/examples
/components/schemas/Emoji/properties/left/examples
/components/schemas/Emoji/properties/right/examples
/components/schemas/Emoji/properties/top/examples
/components/schemas/Emoji/properties/width/examples
/components/schemas/Emoji/properties/x/examples
/components/schemas/Emoji/properties/y/examples
/components/schemas/Emoji/required
/components/schemas/EnvironmentId/examples
/components/schemas/Error/properties/message/examples
/components/schemas/EventId/examples
/components/schemas/EventSearch/properties/pagination_key/examples
/components/schemas/EventSearch/properties/total_hits/examples
/components/schemas/EventUpdate/properties/linked_id/examples
/components/schemas/EventUpdate/properties/tags/required
/components/schemas/EventUpdate/required
/components/schemas/FactoryReset/examples
/components/schemas/FontHash/examples
/components/schemas/FontPreferences/properties/apple/examples
/components/schemas/FontPreferences/properties/default/examples
/components/schemas/FontPreferences/properties/min/examples
/components/schemas/FontPreferences/properties/mono/examples
/components/schemas/FontPreferences/properties/sans/examples
/components/schemas/FontPreferences/properties/serif/examples
/components/schemas/FontPreferences/properties/system/examples
/components/schemas/FontPreferences/required
/components/schemas/Fonts/examples
/components/schemas/Fonts/items/examples
/components/schemas/Geolocation/properties/accuracy_radius/examples
/components/schemas/Geolocation/properties/city_name/examples
/components/schemas/Geolocation/properties/continent_code/examples
/components/schemas/Geolocation/properties/continent_name/examples
/components/schemas/Geolocation/properties/country_code/examples
/components/schemas/Geolocation/properties/country_name/examples
/components/schemas/Geolocation/properties/latitude/examples
/components/schemas/Geolocation/properties/longitude/examples
/components/schemas/Geolocation/properties/postal_code/examples
/components/schemas/Geolocation/properties/subdivisions/items/properties/iso_code/examples
/components/schemas/Geolocation/properties/subdivisions/items/properties/name/examples
/components/schemas/Geolocation/properties/timezone/examples
/components/schemas/Geolocation/required
/components/schemas/HardwareConcurrency/examples
/components/schemas/IPBlockList/required
/components/schemas/IPInfo/required
/components/schemas/IPInfoV4/properties/address/examples
/components/schemas/IPInfoV6/properties/address/examples
/components/schemas/Identification/properties/first_seen_at/examples
/components/schemas/Identification/properties/last_seen_at/examples
/components/schemas/Identification/properties/visitor_id/examples
/components/schemas/IdentificationConfidence/properties/comment/examples
/components/schemas/IdentificationConfidence/properties/score/examples
/components/schemas/IdentificationConfidence/properties/version/examples
/components/schemas/Integration/properties/name/examples
/components/schemas/Integration/properties/subintegration/properties/name/examples
/components/schemas/Integration/properties/subintegration/properties/version/examples
/components/schemas/Integration/properties/subintegration/required
/components/schemas/Integration/properties/version/examples
/components/schemas/Integration/required
/components/schemas/IpAddress/examples
/components/schemas/Labels/items/properties/label/examples
/components/schemas/Labels/items/properties/ml_score/examples
/components/schemas/Languages/items/items/examples
/components/schemas/LinkedId/examples
/components/schemas/Math/examples
/components/schemas/Os/examples
/components/schemas/OsVersion/examples
/components/schemas/Oscpu/examples
/components/schemas/PackageName/examples
/components/schemas/Platform/examples
/components/schemas/Plugins/items/properties/description/examples
/components/schemas/Plugins/items/properties/mimeTypes/items/properties/description/examples
/components/schemas/Plugins/items/properties/mimeTypes/items/properties/suffixes/examples
/components/schemas/Plugins/items/properties/mimeTypes/items/properties/type/examples
/components/schemas/Plugins/items/properties/mimeTypes/items/required
/components/schemas/Plugins/items/properties/name/examples
/components/schemas/Proximity/properties/confidence/examples
/components/schemas/Proximity/properties/id/examples
/components/schemas/ProxyDetails/properties/last_seen_at/examples
/components/schemas/ProxyDetails/properties/provider/examples
/components/schemas/ProxyMLScore/examples
/components/schemas/RawDeviceAttributes/required
/components/schemas/RequestHeaderModifications/properties/remove/items/examples
/components/schemas/RequestHeaderModifications/required
/components/schemas/RuleActionBody/examples
/components/schemas/RuleActionHeaderField/properties/name/examples
/components/schemas/RuleActionHeaderField/properties/value/examples
/components/schemas/RuleExpression/examples
/components/schemas/RuleId/examples
/components/schemas/RulesetId/examples
/components/schemas/SDK/properties/version/examples
/components/schemas/ScreenResolution/items/examples
/components/schemas/StatusCode/examples
/components/schemas/SupplementaryIDHighRecall/properties/first_seen_at/examples
/components/schemas/SupplementaryIDHighRecall/properties/last_seen_at/examples
/components/schemas/SupplementaryIDHighRecall/properties/visitor_id/examples
/components/schemas/SuspectScore/examples
/components/schemas/Tags/required
/components/schemas/TamperingDetails/properties/anomaly_score/examples
/components/schemas/TamperingDetails/required
/components/schemas/TamperingMlScore/examples
/components/schemas/Timestamp/examples
/components/schemas/Timezone/examples
/components/schemas/TimezoneOffset/examples
/components/schemas/TouchSupport/properties/max_touch_points/examples
/components/schemas/TouchSupport/required
/components/schemas/Url/examples
/components/schemas/UserAgent/examples
/components/schemas/Velocity/required
/components/schemas/VelocityData/properties/1_hour/examples
/components/schemas/VelocityData/properties/24_hours/examples
/components/schemas/VelocityData/properties/5_minutes/examples
/components/schemas/Vendor/examples
/components/schemas/VirtualMachineMLScore/examples
/components/schemas/VpnMLScore/examples
/components/schemas/VpnMethods/required
/components/schemas/VpnOriginCountry/examples
/components/schemas/VpnOriginTimezone/examples
/components/schemas/WebGlBasics/properties/renderer/examples
/components/schemas/WebGlBasics/properties/renderer_unmasked/examples
/components/schemas/WebGlBasics/properties/shading_language_version/examples
/components/schemas/WebGlBasics/properties/vendor/examples
/components/schemas/WebGlBasics/properties/vendor_unmasked/examples
/components/schemas/WebGlBasics/properties/version/examples
/components/schemas/WebGlBasics/required
/components/schemas/WebGlExtensions/properties/context_attributes/examples
/components/schemas/WebGlExtensions/properties/extension_parameters/examples
/components/schemas/WebGlExtensions/properties/extensions/examples
/components/schemas/WebGlExtensions/properties/parameters/examples
/components/schemas/WebGlExtensions/properties/shader_precisions/examples
/components/schemas/WebGlExtensions/properties/unsupported_extensions/items/examples
/components/schemas/WebGlExtensions/required
/paths/~1events/get/parameters/0/schema/examples
/paths/~1events/get/parameters/1/schema/examples
/paths/~1events/get/parameters/10/schema/items/examples
/paths/~1events/get/parameters/11/schema/examples
/paths/~1events/get/parameters/12/schema/examples
/paths/~1events/get/parameters/13/schema/examples
/paths/~1events/get/parameters/14/schema/examples
/paths/~1events/get/parameters/15/schema/examples
/paths/~1events/get/parameters/16/schema/examples
/paths/~1events/get/parameters/17/schema/examples
/paths/~1events/get/parameters/18/schema/examples
/paths/~1events/get/parameters/18/schema/oneOf/0/examples
/paths/~1events/get/parameters/18/schema/oneOf/1/examples
/paths/~1events/get/parameters/19/schema/examples
/paths/~1events/get/parameters/19/schema/oneOf/0/examples
/paths/~1events/get/parameters/19/schema/oneOf/1/examples
/paths/~1events/get/parameters/2/schema/examples
/paths/~1events/get/parameters/3/schema/examples
/paths/~1events/get/parameters/35/schema/examples
/paths/~1events/get/parameters/42/schema/examples
/paths/~1events/get/parameters/44/schema/items/examples
/paths/~1events/get/parameters/45/schema/examples
/paths/~1events/get/parameters/46/schema/examples
/paths/~1events/get/parameters/9/schema/items/examples
/paths/~1events~1{event_id}/get/parameters/0/schema/examples
/paths/~1events~1{event_id}/get/parameters/1/schema/examples
/paths/~1events~1{event_id}/patch/parameters/0/schema/examples
/paths/~1visitors~1{visitor_id}/delete/parameters/0/schema/examples

Removed elements (9)

/components/schemas/BatteryLevel/example
/components/schemas/DeviceMemory/example
/components/schemas/Fonts/example
/paths/~1events/get/parameters/0/schema/default
/paths/~1events/get/parameters/0/schema/example
/paths/~1events/get/parameters/18/schema/oneOf/0/example
/paths/~1events/get/parameters/18/schema/oneOf/1/example
/paths/~1events/get/parameters/19/schema/oneOf/0/example
/paths/~1events/get/parameters/19/schema/oneOf/1/example

Modified elements (16)

/components/schemas/BundleId/description
/components/schemas/ClientReferrer/description
/components/schemas/EnvironmentId/description
/components/schemas/EventId/description
/components/schemas/EventUpdate/properties/linked_id/description
/components/schemas/Integration/properties/name/description
/components/schemas/Integration/properties/subintegration/properties/name/description
/components/schemas/Integration/properties/subintegration/properties/version/description
/components/schemas/Integration/properties/version/description
/components/schemas/PackageName/description
/components/schemas/SDK/properties/version/description
/components/schemas/Url/description
/components/schemas/UserAgent/description
/paths/~1events/get/parameters/0/description
/paths/~1events/get/parameters/1/description
/paths/~1events/get/responses/200/content/application~1json/examples/200-ok/value/pagination_key

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -296,20 +296,24 @@
         - name: event_id
           in: path
           required: true
           schema:
             type: string
+            examples:
+              - 1708102555327.NLOjmg
           description: >-
             The unique
             [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id)
             of each identification request (`requestId` can be used in its
             place).
         - name: ruleset_id
           in: query
           required: false
           schema:
             type: string
+            examples:
+              - D6N9Kbk9HRWrIWGz
           description: >
             The ID of the ruleset to evaluate against the event, producing the
             action to take for this event.
 
             The resulting action is returned in the `rule_action` attribute of
@@ -1199,10 +1203,12 @@
         - name: event_id
           in: path
           required: true
           schema:
             type: string
+            examples:
+              - 1708102555327.NLOjmg
           description: >-
             The unique event
             [identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#event_id).
       requestBody:
         required: true
@@ -1355,21 +1361,25 @@
           schema:
             type: integer
             format: int32
             minimum: 1
             maximum: 100
-            default: 10
-            example: 10
+            examples:
+              - 10
           description: >
-            Maximum number of events to return. Results are selected from the
-            time range (`start`, `end`), ordered by `reverse`, then truncated to
-            provided `limit` size. So `reverse=true` returns the oldest
-            N=`limit` events, otherwise the newest N=`limit` events.
+            Maximum number of events to return. Defaults to 10 when omitted.
+            Results are selected from the time range (`start`, `end`), ordered
+            by `reverse`, then truncated to provided `limit` size. So
+            `reverse=true` returns the oldest N=`limit` events, otherwise the
+            newest N=`limit` events.
         - name: pagination_key
           in: query
           schema:
             type: string
+            examples:
+              - >-
+                S9rgMMUb4z3X5t5pr_tSgoSZlmyF0O8X7kCV2m981-iY1LmRTjraa1rTk3L-hQExnDWCi0RA-zAIjaVSTNO2AN2eqQWgzT0RjbieMxRfSdkM-HmOhdOgdQvYfPG3vqU1DJKh4Q
           description: >
             Use `pagination_key` to get the next page of results.
 
 
             When more results are available (e.g., you requested up to 100
@@ -1383,15 +1393,18 @@
 
             1. First request, returning most recent 100 events: `GET
             api-base-url/events?limit=100`
 
             2. Use `response.pagination_key` to get the next page of results:
-            `GET api-base-url/events?limit=100&pagination_key=1740815825085`
+            `GET
+            api-base-url/events?limit=100&pagination_key=S9rgMMUb4z3X5t5pr_tSgoSZlmyF0O8X7kCV2m981-iY1LmRTjraa1rTk3L-hQExnDWCi0RA-zAIjaVSTNO2AN2eqQWgzT0RjbieMxRfSdkM-HmOhdOgdQvYfPG3vqU1DJKh4Q`
         - name: visitor_id
           in: query
           schema:
             type: string
+            examples:
+              - Ibk1527CUFmcnjLwIs4A9
           description: >
             Unique [visitor
             identifier](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id)
             issued by Fingerprint Identification and all active Smart Signals.
 
@@ -1400,10 +1413,12 @@
             property).
         - name: high_recall_id
           in: query
           schema:
             type: string
+            examples:
+              - Ibk1527CUFmcnjLwIs4A9
           description: >
             The High Recall ID is a supplementary browser identifier designed
             for use cases that require wider coverage over precision. Compared
             to the standard visitor ID, the High Recall ID strives to match
             incoming browsers more generously (rather than precisely) with
@@ -1499,10 +1514,12 @@
           style: form
           schema:
             type: array
             items:
               type: string
+              examples:
+                - OpenAI
           description: >
             Filter events by their Bot Info Provider. The provider must match
             exactly, partial or wildcard matching is not supported.
 
 
@@ -1516,10 +1533,12 @@
           style: form
           schema:
             type: array
             items:
               type: string
+              examples:
+                - ChatGPT-User
           description: >
             Filter events by their Bot Info Name. The name must match exactly,
             partial or wildcard matching is not supported.
 
 
@@ -1531,29 +1550,35 @@
             notation are not supported.
         - name: ip_address
           in: query
           schema:
             type: string
+            examples:
+              - 61.127.217.15
           description: >
             Filter events by IP address or IP range (if CIDR notation is used).
             If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is
             assumed.
 
             Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32
         - name: asn
           in: query
           schema:
             type: string
+            examples:
+              - '12876'
           description: >
             Filter events by the ASN associated with the event's IP address.
 
             This corresponds to the `ip_info.(v4|v6).asn` property in the
             response.
         - name: linked_id
           in: query
           schema:
             type: string
+            examples:
+              - somelinkedId
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
@@ -1564,42 +1589,54 @@
             with your custom identifier.
         - name: url
           in: query
           schema:
             type: string
+            examples:
+              - https://example.com/login
           description: |
             Filter events by the URL (`url` property) associated with the event.
         - name: bundle_id
           in: query
           schema:
             type: string
+            examples:
+              - com.example.app
           description: |
             Filter events by the Bundle ID (iOS) associated with the event.
         - name: package_name
           in: query
           schema:
             type: string
+            examples:
+              - com.example.app
           description: >
             Filter events by the Package Name (Android) associated with the
             event.
         - name: origin
           in: query
           schema:
             type: string
+            examples:
+              - https://example.com
           description: >
             Filter events by the origin field of the event. This is applicable
             to web events only (e.g., https://example.com)
         - name: start
           in: query
           schema:
             oneOf:
               - type: integer
                 format: int64
-                example: 1767225600000
+                examples:
+                  - 1767225600000
               - type: string
                 format: date-time
-                example: '2026-01-01T00:00:00Z'
+                examples:
+                  - '2026-01-01T00:00:00Z'
+            examples:
+              - '2026-01-01T00:00:00Z'
           description: >
             Include events that happened after this point (with timestamp
             greater than or equal the provided `start` Unix milliseconds value
             or RFC3339 timestamp). Defaults to 7 days ago. Setting `start` does
             not change `end`'s default of `now` — adjust it separately if
@@ -1608,14 +1645,18 @@
           in: query
           schema:
             oneOf:
               - type: integer
                 format: int64
-                example: 1769903999000
+                examples:
+                  - 1769903999000
               - type: string
                 format: date-time
-                example: '2026-01-31T23:59:59Z'
+                examples:
+                  - '2026-01-31T23:59:59Z'
+            examples:
+              - '2026-01-31T23:59:59Z'
           description: >
             Include events that happened before this point (with timestamp less
             than or equal the provided `end` Unix milliseconds value or RFC3339
             timestamp). Defaults to now. Setting `end` does not change `start`'s
             default of `7 days ago` — adjust it separately if needed.
@@ -1784,10 +1825,12 @@
         - name: min_suspect_score
           in: query
           schema:
             type: number
             format: float
+            examples:
+              - 7.5
           description: >
             Filter events with Suspect Score result above a provided minimum
             threshold.
 
             > Note: When using this parameter, only events where the
@@ -1885,10 +1928,12 @@
             `proxy` Smart Signal result are left out of the response.
         - name: sdk_version
           in: query
           schema:
             type: string
+            examples:
+              - 3.11.14
           description: >
             Filter events by a specific SDK version associated with the
             identification event (`sdk.version` property). Example: `3.11.14`
         - name: sdk_platform
           in: query
@@ -1925,15 +1970,19 @@
           required: false
           schema:
             type: array
             items:
               type: string
+              examples:
+                - ae_47abaca3db2c7c43
           style: form
         - name: proximity_id
           in: query
           schema:
             type: string
+            examples:
+              - C9rJYBlOFsAfBwQ
           description: >
             Filter events by the most precise Proximity ID provided by default.
 
             > Note: When using this parameter, only events with the
             `proximity.id` property matching the provided ID are returned.
@@ -1943,10 +1992,12 @@
           schema:
             type: integer
             format: int64
             minimum: 1
             maximum: 1000
+            examples:
+              - 100
           description: >
             When set, the response will include a `total_hits` property with a
             count of total query matches across all pages, up to the specified
             limit.
         - name: tor_node
@@ -2237,11 +2288,12 @@
                         rare_device_percentile_bucket: <p95
                         labels:
                           - label: fraud
                             prediction: false
                             ml_score: 0.01
-                    pagination_key: '1708102555327'
+                    pagination_key: >-
+                      S9rgMMUb4z3X5t5pr_tSgoSZlmyF0O8X7kCV2m981-iY1LmRTjraa1rTk3L-hQExnDWCi0RA-zAIjaVSTNO2AN2eqQWgzT0RjbieMxRfSdkM-HmOhdOgdQvYfPG3vqU1DJKh4Q
         '400':
           description: >-
             Bad request. One or more supplied search parameters are invalid, or
             a required parameter is missing.
           content:
@@ -2442,10 +2494,12 @@
         - name: visitor_id
           in: path
           required: true
           schema:
             type: string
+            examples:
+              - Ibk1527CUFmcnjLwIs4A9
           description: >-
             The [visitor
             ID](https://docs.fingerprint.com/reference/js-agent-v4-get-function#visitor_id)
             you want to delete.
       responses:
@@ -2611,16 +2665,20 @@
               - name
               - value
             properties:
               name:
                 type: string
+                examples:
+                  - User-Agent
                 description: >-
                   Header name as forwarded by your server. Headers must be valid
                   according to RFC 7230 and will be canonicalized according to
                   RFC 9112.
               value:
                 type: string
+                examples:
+                  - Mozilla/5.0
                 description: >-
                   Value of a single forwarded header entry. Be careful to
                   preserve the original encoding and escaping. For example, do
                   not double escape quotes.
           examples:
@@ -2736,10 +2794,12 @@
             - Browserbase
             - Google
             - OpenAI
         provider_url:
           type: string
+          examples:
+            - https://fingerprint.com
           description: The URL of the bot provider's website.
         name:
           type: string
           description: The specific name or identifier of the bot.
           examples:
@@ -2753,46 +2813,67 @@
         confidence:
           $ref: '#/components/schemas/BotInfoConfidence'
     Geolocation:
       type: object
       additionalProperties: false
+      required: []
       properties:
         accuracy_radius:
           type: integer
+          examples:
+            - 20
           minimum: 0
           description: >-
             The IP address is likely to be within this radius (in km) of the
             specified location.
         latitude:
           type: number
           format: double
+          examples:
+            - 50.05
           minimum: -90
           maximum: 90
         longitude:
           type: number
           format: double
+          examples:
+            - 14.4
           minimum: -180
           maximum: 180
         postal_code:
           type: string
+          examples:
+            - 150 00
         timezone:
           type: string
           format: timezone
+          examples:
+            - Europe/Prague
         city_name:
           type: string
+          examples:
+            - Prague
         country_code:
           type: string
+          examples:
+            - CZ
           minLength: 2
           maxLength: 2
         country_name:
           type: string
+          examples:
+            - Czechia
         continent_code:
           type: string
+          examples:
+            - EU
           minLength: 2
           maxLength: 2
         continent_name:
           type: string
+          examples:
+            - Europe
         subdivisions:
           type: array
           items:
             type: object
             additionalProperties: false
@@ -2800,21 +2881,27 @@
               - iso_code
               - name
             properties:
               iso_code:
                 type: string
+                examples:
+                  - '10'
               name:
                 type: string
+                examples:
+                  - Hlavni mesto Praha
     IPInfoV4:
       type: object
       additionalProperties: false
       required:
         - address
       properties:
         address:
           type: string
           format: ipv4
+          examples:
+            - 94.142.239.124
         geolocation:
           $ref: '#/components/schemas/Geolocation'
         asn:
           type: string
           examples:
@@ -2855,10 +2942,12 @@
         - address
       properties:
         address:
           type: string
           format: ipv6
+          examples:
+            - 2001:db8:3333:4444:5555:6666:7777:8888
         geolocation:
           $ref: '#/components/schemas/Geolocation'
         asn:
           type: string
           examples:
@@ -2896,10 +2985,11 @@
       type: object
       description: >-
         Details about the request IP address. Has separate fields for v4 and v6
         IP address versions.
       additionalProperties: false
+      required: []
       properties:
         v4:
           $ref: '#/components/schemas/IPInfoV4'
         v6:
           $ref: '#/components/schemas/IPInfoV6'
@@ -2937,15 +3027,19 @@
              * `data_center` - proxies which route through data centers
              * `unknown` - reported when a proxy is detected solely by the ML model and the IP sources did not determine a specific type
         last_seen_at:
           type: integer
           format: int64
+          examples:
+            - 1708102555327
           description: >
             Unix millisecond timestamp with hourly resolution of when this IP
             was last seen as a proxy
         provider:
           type: string
+          examples:
+            - Massive
           description: >
             String representing the last proxy service provider detected when
             this
 
             IP was synced. An IP can be shared by multiple service providers.
@@ -2964,10 +3058,11 @@
         "high". Depends on the combination of results returned from all VPN
         detection methods.
     VpnMethods:
       type: object
       additionalProperties: false
+      required: []
       properties:
         timezone_mismatch:
           type: boolean
           x-platforms:
             - android
@@ -3138,28 +3233,33 @@
       properties:
         code:
           $ref: '#/components/schemas/ErrorCode'
         message:
           type: string
+          examples:
+            - Forbidden
     ErrorResponse:
       type: object
       additionalProperties: false
       required:
         - error
       properties:
         error:
           $ref: '#/components/schemas/Error'
     EventId:
       type: string
+      examples:
+        - 1708102555327.NLOjmg
       description: >
         Unique identifier of the user's request. The first portion of the
-        event_id is a unix epoch milliseconds timestamp For example:
-        `1758130560902.8tRtrH`
+        event_id is a unix epoch milliseconds timestamp.
     Timestamp:
       description: Timestamp of the event with millisecond precision in Unix time.
       type: integer
       format: int64
+      examples:
+        - 1708102555327
     IncrementalIdentificationStatus:
       type: string
       description: >
         Only included for requests using incremental identification.
 
@@ -3173,41 +3273,54 @@
       enum:
         - partially_completed
         - completed
     LinkedId:
       type: string
+      examples:
+        - somelinkedId
       description: A customer-provided id that was sent with the request.
     EnvironmentId:
       type: string
-      description: |
-        Environment Id of the event. For example: `ae_47abaca3db2c7c43`
+      examples:
+        - ae_47abaca3db2c7c43
+      description: Environment Id of the event.
     Suspect:
       type: boolean
       description: >-
         Field is `true` if you have previously set the `suspect` flag for this
         event using the [Server API Update event
         endpoint](https://docs.fingerprint.com/reference/server-api-v4-update-event).
     Integration:
       type: object
       additionalProperties: false
+      required: []
       properties:
         name:
           type: string
-          description: The name of the specific integration, e.g. "fingerprint-pro-react".
+          examples:
+            - fingerprint-pro-react
+          description: The name of the specific integration.
         version:
           type: string
-          description: The version of the specific integration, e.g. "3.11.10".
+          examples:
+            - 3.11.10
+          description: The version of the specific integration.
         subintegration:
           type: object
           additionalProperties: false
+          required: []
           properties:
             name:
               type: string
-              description: The name of the specific subintegration, e.g. "preact".
+              examples:
+                - preact
+              description: The name of the specific subintegration.
             version:
               type: string
-              description: The version of the specific subintegration, e.g. "10.21.0".
+              examples:
+                - 10.21.0
+              description: The version of the specific subintegration.
     SDK:
       type: object
       description: Contains information about the SDK used to perform the request.
       additionalProperties: false
       required:
@@ -3222,13 +3335,13 @@
             - ios
             - unknown
           description: Platform of the SDK used for the identification request.
         version:
           type: string
-          description: >
-            Version string of the SDK used for the identification request. For
-            example: `"3.12.1"`
+          examples:
+            - 3.11.10
+          description: Version string of the SDK used for the identification request.
         integrations:
           type: array
           items:
             $ref: '#/components/schemas/Integration'
     Replayed:
@@ -3250,32 +3363,40 @@
         - score
       properties:
         score:
           type: number
           format: double
+          examples:
+            - 0.97
           minimum: 0
           maximum: 1
           description: >-
             A floating-point number between 0 and 1 that represents the
             probability of a false-positive identification. For High Recall ID,
             this value is 0. 
         version:
           type: string
+          examples:
+            - '1.1'
           description: >-
             The version name of the method used to calculate the confidence
             score. For High Recall ID, this value is "Not Supported". 
         comment:
           type: string
+          examples:
+            - Low confidence due to bot signals
     Identification:
       type: object
       additionalProperties: false
       required:
         - visitor_id
         - visitor_found
       properties:
         visitor_id:
           type: string
+          examples:
+            - Ibk1527CUFmcnjLwIs4A9
           description: >-
             String of 20 characters that uniquely identifies the visitor's
             browser or mobile device.
         confidence:
           $ref: '#/components/schemas/IdentificationConfidence'
@@ -3283,17 +3404,21 @@
           type: boolean
           description: Attribute represents if a visitor had been identified before.
         first_seen_at:
           type: integer
           format: int64
+          examples:
+            - 1708102555327
           description: >
             Unix epoch time milliseconds timestamp indicating the time at which
             this visitor ID was first seen. example: `1758069706642` -
             Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000
         last_seen_at:
           type: integer
           format: int64
+          examples:
+            - 1708102555327
           description: >
             Unix epoch time milliseconds timestamp indicating the time at which
             this visitor ID was last seen. example: `1758069706642` -
             Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000
     SupplementaryIDHighRecall:
@@ -3311,10 +3436,12 @@
         - visitor_id
         - visitor_found
       properties:
         visitor_id:
           type: string
+          examples:
+            - 0jnGMkPYXX37DqVa4ZIO3f_hr
           description: >-
             The High Recall identifier for the visitor's browser. It is an
             alphanumeric string with a maximum length of 25 characters.
         visitor_found:
           type: boolean
@@ -3324,76 +3451,100 @@
         confidence:
           $ref: '#/components/schemas/IdentificationConfidence'
         first_seen_at:
           type: integer
           format: int64
+          examples:
+            - 1778086556130
           description: >
             Unix epoch timestamp (in milliseconds) indicating when the browser
             was first identified. example: `1758069706642` - Corresponding to
             Wed Sep 17 2025 00:41:46 GMT+0000
         last_seen_at:
           type: integer
           format: int64
+          examples:
+            - 1778604975494
           description: >
             Unix epoch timestamp (in milliseconds) corresponding to the most
             recent visit by this browser. example: `1758069706642` -
             Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000
     Tags:
       type: object
       description: >-
         A customer-provided value or an object that was sent with the
         identification request or updated later.
       additionalProperties: true
+      required: []
     Url:
       type: string
-      description: >
-        Page URL from which the request was sent. For example
-        `https://example.com/`
+      examples:
+        - https://www.example.com/login
+      description: Page URL from which the request was sent.
     BundleId:
       type: string
+      examples:
+        - com.foo.app
       description: >
         Bundle Id of the iOS application integrated with the Fingerprint SDK for
-        the event. For example: `com.foo.app`
+        the event.
     PackageName:
       type: string
+      examples:
+        - com.foo.app
       description: >
         Package name of the Android application integrated with the Fingerprint
-        SDK for the event. For example: `com.foo.app`
+        SDK for the event.
     IpAddress:
       type: string
+      examples:
+        - 61.127.217.15
       description: IP address of the requesting browser or bot.
     UserAgent:
       type: string
-      description: >
-        User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1;
-        Win64; x64) ....`
+      examples:
+        - Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....
+      description: User Agent of the client.
     Device:
       type: string
+      examples:
+        - Generic Smartphone
+        - Desktop
+        - iPhone
       description: >
         Device model or family extracted from the user agent string (e.g.
         `iPhone`, `Generic Smartphone`, `Desktop`). On web, this field is also
         present inside `browser_details`.
     Os:
       type: string
+      examples:
+        - Windows
+        - iOS
+        - Android
       description: >
         Operating system family extracted from the user agent string (e.g.
         `iOS`, `Android`, `Windows`). On web, this field is also present inside
         `browser_details`.
     OsVersion:
       type: string
+      examples:
+        - '17.4'
+        - '14'
+        - '10'
       description: >
         Operating system version string extracted from the user agent string
         (e.g. `17.4`, `14`, `10`). On web, this field is also present inside
         `browser_details`.
     ClientReferrer:
       type: string
+      examples:
+        - https://example.com/blog/my-article
       description: >
         Client Referrer field corresponds to the `document.referrer` field
         gathered during an identification request. The value is an empty string
         if the user navigated to the page directly (not through a link, but, for
-        example, by using a bookmark) For example:
-        `https://example.com/blog/my-article`
+        example, by using a bookmark).
     BrowserDetails:
       type: object
       additionalProperties: false
       required:
         - browser_name
@@ -3403,20 +3554,32 @@
         - os_version
         - device
       properties:
         browser_name:
           type: string
+          examples:
+            - Chrome
         browser_major_version:
           type: string
+          examples:
+            - '74'
         browser_full_version:
           type: string
+          examples:
+            - 74.0.3729
         os:
           type: string
+          examples:
+            - Windows
         os_version:
           type: string
+          examples:
+            - '7'
         device:
           type: string
+          examples:
+            - Other
     Proximity:
       type: object
       description: >
         Proximity ID represents a fixed geographical zone in a discrete global
         grid within which the device is observed.
@@ -3426,10 +3589,12 @@
         - precision_radius
         - confidence
       properties:
         id:
           type: string
+          examples:
+            - w1aTfd4MCvl
           description: |
             A stable privacy-preserving identifier for a given proximity zone.
         precision_radius:
           type: integer
           format: int32
@@ -3446,10 +3611,12 @@
           description: |
             The radius of the proximity zone’s precision level, in meters.
         confidence:
           type: number
           format: float
+          examples:
+            - 0.95
           minimum: 0
           maximum: 1
           description: >
             A value between `0` and `1` representing the likelihood that the
             true device location lies within the mapped proximity zone.
@@ -3466,10 +3633,12 @@
          * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on
          * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on
          * `not_detected` - the visitor is not a bot
     BotType:
       type: string
+      examples:
+        - fingerprint_agent
       description: |
         Additional classification of the bot type if detected.
     ClonedApp:
       type: boolean
       description: >
@@ -3496,10 +3665,12 @@
         * `false` - No signs of emulated environment detected or the client is
         not Android.
     FactoryReset:
       type: integer
       format: int64
+      examples:
+        - 1708102555327
       description: >
         The time of the most recent factory reset that happened on the **mobile
         device** is expressed as Unix epoch time. When a factory reset cannot be
         detected on the mobile device or when the request is initiated from a
         browser,  this field will correspond to the *epoch* time (i.e 1 Jan 1970
@@ -3516,10 +3687,11 @@
 
         * `false` - No signs of Frida or the client is not a mobile device.
     IPBlockList:
       type: object
       additionalProperties: false
+      required: []
       properties:
         email_spam:
           type: boolean
           description: IP address was part of a known email spam attack (SMTP).
         attack_source:
@@ -3529,10 +3701,12 @@
           type: boolean
           description: IP address was part of known TOR network activity.
     ProxyMLScore:
       type: number
       format: double
+      examples:
+        - 0.2
       minimum: 0
       maximum: 1
       description: >
         Machine learning–based proxy score, represented as a floating-point
         value between 0 and 1 (inclusive), with up to three decimal places of
@@ -3581,16 +3755,22 @@
 
         * `false` - No Root Management Apps detected or the client isn't
         Android.
     RulesetId:
       type: string
+      examples:
+        - rs_b1k1blhqpOX3kU
       description: The ID of the evaluated ruleset.
     RuleId:
       type: string
+      examples:
+        - r_uE0af8497PFAOD
       description: The ID of the rule that matched the identification event.
     RuleExpression:
       type: string
+      examples:
+        - bot in ["bad"] || incognito
       description: The expression of the rule that matched the identification event.
     RuleActionType:
       type: string
       description: Describes the action to take with the request.
       enum:
@@ -3602,25 +3782,32 @@
         - name
         - value
       properties:
         name:
           type: string
+          examples:
+            - Content-Type
           description: The header field name.
         value:
           type: string
+          examples:
+            - application/json
           description: The value of the header field.
     RequestHeaderModifications:
       type: object
       description: >-
         The set of header modifications to apply, in the following order:
         remove, set, append.
+      required: []
       properties:
         remove:
           type: array
           description: The list of headers to remove.
           items:
             type: string
+            examples:
+              - X-Forwarded-For
         set:
           type: array
           description: >-
             The list of headers to set, overwriting any existing headers with
             the same name.
@@ -3653,13 +3840,17 @@
       required:
         - ruleset_id
         - type
     StatusCode:
       type: integer
+      examples:
+        - 200
       description: A valid HTTP status code.
     RuleActionBody:
       type: string
+      examples:
+        - '{"title":"Forbidden"}'
       description: The response body to send to the client.
     EventRuleActionBlock:
       description: >-
         Informs the client the request should be blocked using the response
         described by this rule action.
@@ -3709,10 +3900,12 @@
         iOS specific simulator detection. There are 2 values:
         * `true` - Simulator environment detected.
         * `false` - No signs of simulator or the client is not iOS.
     SuspectScore:
       type: integer
+      examples:
+        - 8
       description: >
         Suspect Score is an easy way to integrate Smart Signals into your fraud
         protection work flow.  It is a weighted representation of all Smart
         Signals present in the payload that helps identify suspicious activity.
         The value range is [0; S] where S is sum of all Smart Signals weights. 
@@ -3761,10 +3954,12 @@
         * **High confidence:** Strong signals suggest the user is not tampering
         with their request.
     TamperingMlScore:
       type: number
       format: double
+      examples:
+        - 0.5
       minimum: 0
       maximum: 1
       description: >
         The output of this model is captured as tampering_ml_score, a number
         indicating how likely an event is coming from an anti detect browser.
@@ -3772,14 +3967,17 @@
         above the threshold of 0.8 to be actionable (the result and
         anti_detect_browser fields conveniently captures that fact)
     TamperingDetails:
       type: object
       additionalProperties: false
+      required: []
       properties:
         anomaly_score:
           type: number
           format: double
+          examples:
+            - 0.5
           minimum: 0
           maximum: 1
           x-platforms:
             - android
             - ios
@@ -3818,20 +4016,26 @@
         - 5_minutes
         - 1_hour
       properties:
         5_minutes:
           type: integer
+          examples:
+            - 1
           description: >
             Count for the last 5 minutes of velocity data, from the time of the
             event.
         1_hour:
           type: integer
+          examples:
+            - 5
           description: >
             Count for the last 1 hour of velocity data, from the time of the
             event.
         24_hours:
           type: integer
+          examples:
+            - 5
           description: >
             The `24_hours` interval of `distinct_ip`, `distinct_linked_id`,
             `distinct_country`, `distinct_ip_by_linked_id` and
             `distinct_visitor_id_by_linked_id` will be omitted if the number of
             `events` for the visitor Id in the last 24 hours
@@ -3876,10 +4080,11 @@
         All will not necessarily be returned in a response, some may be omitted
         if the 
 
         associated event does not have the required data, such as a linked_id.
       additionalProperties: false
+      required: []
       properties:
         distinct_ip:
           $ref: '#/components/schemas/VelocityData'
         distinct_linked_id:
           $ref: '#/components/schemas/VelocityData'
@@ -3899,10 +4104,12 @@
         `true` if the request came from a browser running inside a virtual
         machine (e.g. VMWare), `false` otherwise.
     VirtualMachineMLScore:
       type: number
       format: double
+      examples:
+        - 0.5
       minimum: 0
       maximum: 1
       description: >
         Machine learning–based virtual machine score, represented as a
         floating-point value between 0 and 1 (inclusive), with up to three
@@ -3912,10 +4119,12 @@
         interested, please [contact our support
         team](https://fingerprint.com/support/).
     VpnMLScore:
       type: number
       format: double
+      examples:
+        - 0.2
       minimum: 0
       maximum: 1
       description: >
         Machine learning–based VPN score, represented as a floating-point value
         between 0 and 1 (inclusive), with up to three decimal places of
@@ -3923,14 +4132,18 @@
         `vpn` detection result. This Smart Signal is currently in beta and only
         available to select customers. If you are interested, please [contact
         our support team](https://fingerprint.com/support/).
     VpnOriginTimezone:
       type: string
+      examples:
+        - Europe/Berlin
       description: |
         Local timezone which is used in timezone_mismatch method.
     VpnOriginCountry:
       type: string
+      examples:
+        - DE
       description: >
         Country of the request (only for Android SDK version >= 2.4.0, ISO 3166
         format or unknown).
     HighActivity:
       type: boolean
@@ -3968,95 +4181,139 @@
       description: >
         Baseline measurement of canonical fonts rendered on the device. Numeric
         width metrics, in CSS pixels, for the canonical fonts collected by the
         agent.
       additionalProperties: false
+      required: []
       properties:
         default:
           type: number
           format: double
+          examples:
+            - 147.5625
         serif:
           type: number
           format: double
+          examples:
+            - 147.5625
         sans:
           type: number
           format: double
+          examples:
+            - 144.015625
         mono:
           type: number
           format: double
+          examples:
+            - 133.0625
         apple:
           type: number
           format: double
+          examples:
+            - 147.5625
         min:
           type: number
           format: double
+          examples:
+            - 9.234375
         system:
           type: number
           format: double
+          examples:
+            - 146.09375
     Emoji:
       type: object
       description: Bounding box metrics describing how the emoji glyph renders.
       additionalProperties: false
+      required: []
       properties:
         font:
           type: string
+          examples:
+            - Times
           description: Font family reported by the browser when drawing the emoji.
         width:
           type: number
           format: double
+          examples:
+            - 1600
         height:
           type: number
           format: double
+          examples:
+            - 18
         top:
           type: number
           format: double
+          examples:
+            - 14
         bottom:
           type: number
           format: double
+          examples:
+            - 32
         left:
           type: number
           format: double
+          examples:
+            - 8
         right:
           type: number
           format: double
+          examples:
+            - 1608
         x:
           type: number
           format: double
+          examples:
+            - 8
         'y':
           type: number
           format: double
+          examples:
+            - 14
     Fonts:
       type: array
       description: List of fonts detected on the device.
       items:
         type: string
-      example:
-        - Arial Unicode MS
-        - Gill Sans
-        - Helvetica Neue
-        - Menlo
+        examples:
+          - Arial Unicode MS
+      examples:
+        - - Arial Unicode MS
+          - Gill Sans
+          - Helvetica Neue
+          - Menlo
     DeviceMemory:
       type: integer
       format: int32
       minimum: 0
-      example: 8
+      examples:
+        - 8
       description: Rounded amount of RAM in gigabytes.
     Timezone:
       type: string
+      examples:
+        - America/Sao_Paulo
       description: Timezone identifier detected on the client.
     Canvas:
       type: object
       description: Canvas fingerprint containing winding flag plus geometry/text hashes.
       additionalProperties: false
+      required: []
       properties:
         winding:
           type: boolean
         geometry:
           type: string
+          examples:
+            - db3c1462576a399a03ae93d0ab9eb5c4
           description: Hash of geometry rendering output or `unsupported` markers.
         text:
           type: string
+          examples:
+            - 70c3d3f7eb4408dc37a6bf8af1c51029
           description: Hash of text rendering output or `unsupported` markers.
     Languages:
       type: array
       description: >
         Navigator languages reported by the agent including fallbacks. Each
@@ -4064,82 +4321,123 @@
         different APIs. Available for browsers, iOS, and Android devices.
       items:
         type: array
         items:
           type: string
+          examples:
+            - en-US
     WebGlExtensions:
       type: object
       description: Hashes of WebGL context attributes and extension support.
       additionalProperties: false
+      required: []
       properties:
         context_attributes:
           type: string
+          examples:
+            - 6b1ed336830d2bc96442a9d76373252a
         parameters:
           type: string
+          examples:
+            - ea118c48e308bc4b0677118bbb3019ec
         shader_precisions:
           type: string
+          examples:
+            - f223dfbcd580cf142da156d93790eb83
         extensions:
           type: string
+          examples:
+            - 57233d7b10f89fcd1ff95e3837ccd72d
         extension_parameters:
           type: string
+          examples:
+            - 86a8abb36f0cb30b5946dec0c761d042
         unsupported_extensions:
           type: array
           items:
             type: string
+            examples:
+              - WEBGL_compressed_texture_s3tc_srgb
     WebGlBasics:
       type: object
       description: Render and vendor strings reported by the WebGL context.
       additionalProperties: false
+      required: []
       properties:
         version:
           type: string
+          examples:
+            - WebGL 1.0 (OpenGL ES 2.0 Chromium)
         vendor:
           type: string
+          examples:
+            - WebKit
         vendor_unmasked:
           type: string
+          examples:
+            - Google Inc. (Apple)
         renderer:
           type: string
+          examples:
+            - WebKit WebGL
         renderer_unmasked:
           type: string
+          examples:
+            - 'ANGLE (Apple, ANGLE Metal Renderer: Apple M4, Unspecified Version)'
         shading_language_version:
           type: string
+          examples:
+            - WebGL GLSL ES 1.0 (OpenGL ES GLSL ES 1.0 Chromium)
     ScreenResolution:
       type: array
       description: Current screen resolution. Available for both browsers and iOS devices
       minItems: 2
       maxItems: 2
       items:
         type: integer
         format: int32
+        examples:
+          - 1920
     TouchSupport:
       type: object
       description: Browser-reported touch capabilities.
       additionalProperties: false
+      required: []
       properties:
         touch_event:
           type: boolean
         touch_start:
           type: boolean
         max_touch_points:
           type: integer
           format: int64
+          examples:
+            - 0
     Oscpu:
       type: string
+      examples:
+        - Windows NT 6.1; Win64; x64
       description: Navigator `oscpu` string.
     Architecture:
       type: integer
       format: int32
+      examples:
+        - 127
       description: Integer representing the CPU architecture exposed by the browser.
     CookiesEnabled:
       type: boolean
       description: Whether the cookies are enabled in the browser.
     HardwareConcurrency:
       type: integer
       format: int32
+      examples:
+        - 10
       description: Number of logical CPU cores reported by the browser.
     DateTimeLocale:
       type: string
+      examples:
+        - en-US
       description: >
         Locale derived from the Intl.DateTimeFormat API. Negative values
         indicate known error states. The negative statuses can be:
 
         - "-1": A permanent status for browsers that don't support Intl API.
@@ -4149,27 +4447,35 @@
 
         - "-3": A permanent status for browsers in which DateTimeFormat locale
         is undefined or null.
     Vendor:
       type: string
+      examples:
+        - Google Inc.
       description: Navigator vendor string.
     ColorDepth:
       type: integer
       format: int32
+      examples:
+        - 24
       description: Screen color depth in bits.
     Platform:
       type: string
+      examples:
+        - MacIntel
       description: Navigator platform string.
     SessionStorage:
       type: boolean
       description: Whether sessionStorage is available.
     LocalStorage:
       type: boolean
       description: Whether localStorage is available.
     Audio:
       type: number
       format: double
+      examples:
+        - 124.04347745512496
       description: >
         AudioContext fingerprint or negative status when unavailable. The
         negative statuses can be:
 
         - -1: A permanent status for those browsers which are known to always
@@ -4186,50 +4492,72 @@
         type: object
         additionalProperties: false
         properties:
           name:
             type: string
+            examples:
+              - PDF Viewer
           description:
             type: string
+            examples:
+              - Portable Document Format
           mimeTypes:
             type: array
             items:
               type: object
               additionalProperties: false
+              required: []
               properties:
                 type:
                   type: string
+                  examples:
+                    - application/pdf
                 suffixes:
                   type: string
+                  examples:
+                    - pdf
                 description:
                   type: string
+                  examples:
+                    - Portable Document Format
         required:
           - name
     IndexedDb:
       type: boolean
       description: Whether IndexedDB is available.
     Math:
       type: string
+      examples:
+        - 5f030fa7d2e5f9f757bfaf81642eb1a6
       description: Hash of Math APIs used for entropy collection.
     DeviceModel:
       type: string
+      examples:
+        - iPhone 15 Pro
       description: Device model string. Available only for Android and iOS devices.
     DeviceManufacturer:
       type: string
+      examples:
+        - Apple
       description: Device manufacturer string. Available only for Android and iOS devices.
     FontHash:
       type: string
+      examples:
+        - e9f96f6c0e2c0b3a7a8b1d2c3e4f5a6b
       description: Unique identifier for the user’s installed fonts.
     TimezoneOffset:
       type: string
+      examples:
+        - '+02:00'
       description: UTC offset in "±HH:MM" format derived from the detected IANA timezone.
     BatteryLevel:
       type: integer
       format: int32
       minimum: 0
       maximum: 100
-      example: 75
+      examples:
+        - 75
       description: >-
         Battery charge level as a percentage (0-100). Available only for Android
         and iOS devices.
     BatteryLowPowerMode:
       type: boolean
@@ -4241,10 +4569,11 @@
       description: >
         A curated subset of raw browser/device attributes that the API surface
         exposes. Each property contains a value or object with the data for the
         collected signal.
       additionalProperties: false
+      required: []
       properties:
         font_preferences:
           $ref: '#/components/schemas/FontPreferences'
         emoji:
           $ref: '#/components/schemas/Emoji'
@@ -4314,15 +4643,19 @@
         required:
           - label
         properties:
           label:
             type: string
+            examples:
+              - automation_tool
           prediction:
             type: boolean
           ml_score:
             type: number
             format: double
+            examples:
+              - 0.95
             minimum: 0
             maximum: 1
       description: >
         Each label returns a prediction (true or false) for a specific use case
         (label field) based on a machine learning score. The machine learning
@@ -4665,20 +4998,24 @@
             - browser
             - ios
             - android
     EventUpdate:
       type: object
+      required: []
       properties:
         linked_id:
           type: string
-          description: Linked Id value to assign to the existing event
+          examples:
+            - somelinkedId
+          description: Linked ID value to assign to the existing event
         tags:
           type: object
           description: >-
             A customer-provided value or an object that was sent with the
             identification request or updated later.
           additionalProperties: true
+          required: []
         suspect:
           type: boolean
           description: Suspect flag indicating observed suspicious or fraudulent event
           x-go-force-pointer: true
     EventSearch:
@@ -4694,15 +5031,20 @@
           type: array
           items:
             $ref: '#/components/schemas/Event'
         pagination_key:
           type: string
+          examples:
+            - >-
+              S9rgMMUb4z3X5t5pr_tSgoSZlmyF0O8X7kCV2m981-iY1LmRTjraa1rTk3L-hQExnDWCi0RA-zAIjaVSTNO2AN2eqQWgzT0RjbieMxRfSdkM-HmOhdOgdQvYfPG3vqU1DJKh4Q
           description: >-
             Use this value in the `pagination_key` parameter to request the next
             page of search results.
         total_hits:
           type: integer
           format: int64
+          examples:
+            - 100
           description: >-
             This value represents the total number of events matching the search
             query, up to the limit provided in the `total_hits` query parameter.
             Only present if the `total_hits` query parameter was provided.

`fingerprint-server-api-v4.yaml`

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4.yaml
Summary: +20 added, -9 removed, ~15 modified

Added elements (20)

/components/schemas/Canvas/required
/components/schemas/Emoji/required
/components/schemas/EventUpdate/properties/tags/required
/components/schemas/EventUpdate/required
/components/schemas/FontPreferences/required
/components/schemas/Geolocation/required
/components/schemas/IPBlockList/required
/components/schemas/IPInfo/required
/components/schemas/Integration/properties/subintegration/required
/components/schemas/Integration/required
/components/schemas/Plugins/items/properties/mimeTypes/items/required
/components/schemas/RawDeviceAttributes/required
/components/schemas/RequestHeaderModifications/required
/components/schemas/Tags/required
/components/schemas/TamperingDetails/required
/components/schemas/TouchSupport/required
/components/schemas/Velocity/required
/components/schemas/VpnMethods/required
/components/schemas/WebGlBasics/required
/components/schemas/WebGlExtensions/required

Removed elements (9)

/components/schemas/BatteryLevel/example
/components/schemas/DeviceMemory/example
/components/schemas/Fonts/example
/paths/~1events/get/parameters/0/schema/default
/paths/~1events/get/parameters/0/schema/example
/paths/~1events/get/parameters/18/schema/oneOf/0/example
/paths/~1events/get/parameters/18/schema/oneOf/1/example
/paths/~1events/get/parameters/19/schema/oneOf/0/example
/paths/~1events/get/parameters/19/schema/oneOf/1/example

Modified elements (15)

/components/schemas/BundleId/description
/components/schemas/ClientReferrer/description
/components/schemas/EnvironmentId/description
/components/schemas/EventId/description
/components/schemas/EventUpdate/properties/linked_id/description
/components/schemas/Integration/properties/name/description
/components/schemas/Integration/properties/subintegration/properties/name/description
/components/schemas/Integration/properties/subintegration/properties/version/description
/components/schemas/Integration/properties/version/description
/components/schemas/PackageName/description
/components/schemas/SDK/properties/version/description
/components/schemas/Url/description
/components/schemas/UserAgent/description
/paths/~1events/get/parameters/0/description
/paths/~1events/get/parameters/1/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -247,17 +247,16 @@
           schema:
             type: integer
             format: int32
             minimum: 1
             maximum: 100
-            default: 10
-            example: 10
           description: >
-            Maximum number of events to return. Results are selected from the
-            time range (`start`, `end`), ordered by `reverse`, then truncated to
-            provided `limit` size. So `reverse=true` returns the oldest
-            N=`limit` events, otherwise the newest N=`limit` events.
+            Maximum number of events to return. Defaults to 10 when omitted.
+            Results are selected from the time range (`start`, `end`), ordered
+            by `reverse`, then truncated to provided `limit` size. So
+            `reverse=true` returns the oldest N=`limit` events, otherwise the
+            newest N=`limit` events.
         - name: pagination_key
           in: query
           schema:
             type: string
           description: >
@@ -275,11 +274,12 @@
 
             1. First request, returning most recent 100 events: `GET
             api-base-url/events?limit=100`
 
             2. Use `response.pagination_key` to get the next page of results:
-            `GET api-base-url/events?limit=100&pagination_key=1740815825085`
+            `GET
+            api-base-url/events?limit=100&pagination_key=S9rgMMUb4z3X5t5pr_tSgoSZlmyF0O8X7kCV2m981-iY1LmRTjraa1rTk3L-hQExnDWCi0RA-zAIjaVSTNO2AN2eqQWgzT0RjbieMxRfSdkM-HmOhdOgdQvYfPG3vqU1DJKh4Q`
         - name: visitor_id
           in: query
           schema:
             type: string
           description: >
@@ -476,14 +476,12 @@
           in: query
           schema:
             oneOf:
               - type: integer
                 format: int64
-                example: 1767225600000
               - type: string
                 format: date-time
-                example: '2026-01-01T00:00:00Z'
           description: >
             Include events that happened after this point (with timestamp
             greater than or equal the provided `start` Unix milliseconds value
             or RFC3339 timestamp). Defaults to 7 days ago. Setting `start` does
             not change `end`'s default of `now` — adjust it separately if
@@ -492,14 +490,12 @@
           in: query
           schema:
             oneOf:
               - type: integer
                 format: int64
-                example: 1769903999000
               - type: string
                 format: date-time
-                example: '2026-01-31T23:59:59Z'
           description: >
             Include events that happened before this point (with timestamp less
             than or equal the provided `end` Unix milliseconds value or RFC3339
             timestamp). Defaults to now. Setting `end` does not change `start`'s
             default of `7 days ago` — adjust it separately if needed.
@@ -1085,10 +1081,11 @@
             - medium
             - high
           description: Confidence level of the bot identification.
     Geolocation:
       type: object
+      required: []
       properties:
         accuracy_radius:
           type: integer
           minimum: 0
           description: >-
@@ -1184,10 +1181,11 @@
     IPInfo:
       type: object
       description: >-
         Details about the request IP address. Has separate fields for v4 and v6
         IP address versions.
+      required: []
       properties:
         v4:
           $ref: '#/components/schemas/IPInfoV4'
         v6:
           $ref: '#/components/schemas/IPInfoV6'
@@ -1250,10 +1248,11 @@
         A confidence rating for the VPN detection result — "low", "medium", or
         "high". Depends on the combination of results returned from all VPN
         detection methods.
     VpnMethods:
       type: object
+      required: []
       properties:
         timezone_mismatch:
           type: boolean
           x-platforms:
             - android
@@ -1409,12 +1408,11 @@
           $ref: '#/components/schemas/Error'
     EventId:
       type: string
       description: >
         Unique identifier of the user's request. The first portion of the
-        event_id is a unix epoch milliseconds timestamp For example:
-        `1758130560902.8tRtrH`
+        event_id is a unix epoch milliseconds timestamp.
     Timestamp:
       description: Timestamp of the event with millisecond precision in Unix time.
       type: integer
       format: int64
     IncrementalIdentificationStatus:
@@ -1435,36 +1433,37 @@
     LinkedId:
       type: string
       description: A customer-provided id that was sent with the request.
     EnvironmentId:
       type: string
-      description: |
-        Environment Id of the event. For example: `ae_47abaca3db2c7c43`
+      description: Environment Id of the event.
     Suspect:
       type: boolean
       description: >-
         Field is `true` if you have previously set the `suspect` flag for this
         event using the [Server API Update event
         endpoint](https://docs.fingerprint.com/reference/server-api-v4-update-event).
     Integration:
       type: object
+      required: []
       properties:
         name:
           type: string
-          description: The name of the specific integration, e.g. "fingerprint-pro-react".
+          description: The name of the specific integration.
         version:
           type: string
-          description: The version of the specific integration, e.g. "3.11.10".
+          description: The version of the specific integration.
         subintegration:
           type: object
+          required: []
           properties:
             name:
               type: string
-              description: The name of the specific subintegration, e.g. "preact".
+              description: The name of the specific subintegration.
             version:
               type: string
-              description: The version of the specific subintegration, e.g. "10.21.0".
+              description: The version of the specific subintegration.
     SDK:
       type: object
       description: Contains information about the SDK used to perform the request.
       required:
         - platform
@@ -1478,13 +1477,11 @@
             - ios
             - unknown
           description: Platform of the SDK used for the identification request.
         version:
           type: string
-          description: >
-            Version string of the SDK used for the identification request. For
-            example: `"3.12.1"`
+          description: Version string of the SDK used for the identification request.
         integrations:
           type: array
           items:
             $ref: '#/components/schemas/Integration'
     Replayed:
@@ -1594,33 +1591,30 @@
       type: object
       description: >-
         A customer-provided value or an object that was sent with the
         identification request or updated later.
       additionalProperties: true
+      required: []
     Url:
       type: string
-      description: >
-        Page URL from which the request was sent. For example
-        `https://example.com/`
+      description: Page URL from which the request was sent.
     BundleId:
       type: string
       description: >
         Bundle Id of the iOS application integrated with the Fingerprint SDK for
-        the event. For example: `com.foo.app`
+        the event.
     PackageName:
       type: string
       description: >
         Package name of the Android application integrated with the Fingerprint
-        SDK for the event. For example: `com.foo.app`
+        SDK for the event.
     IpAddress:
       type: string
       description: IP address of the requesting browser or bot.
     UserAgent:
       type: string
-      description: >
-        User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1;
-        Win64; x64) ....`
+      description: User Agent of the client.
     Device:
       type: string
       description: >
         Device model or family extracted from the user agent string (e.g.
         `iPhone`, `Generic Smartphone`, `Desktop`). On web, this field is also
@@ -1641,12 +1635,11 @@
       type: string
       description: >
         Client Referrer field corresponds to the `document.referrer` field
         gathered during an identification request. The value is an empty string
         if the user navigated to the page directly (not through a link, but, for
-        example, by using a bookmark) For example:
-        `https://example.com/blog/my-article`
+        example, by using a bookmark).
     BrowserDetails:
       type: object
       required:
         - browser_name
         - browser_full_version
@@ -1766,10 +1759,11 @@
         * `true` - Frida detected
 
         * `false` - No signs of Frida or the client is not a mobile device.
     IPBlockList:
       type: object
+      required: []
       properties:
         email_spam:
           type: boolean
           description: IP address was part of a known email spam attack (SMTP).
         attack_source:
@@ -1861,10 +1855,11 @@
     RequestHeaderModifications:
       type: object
       description: >-
         The set of header modifications to apply, in the following order:
         remove, set, append.
+      required: []
       properties:
         remove:
           type: array
           description: The list of headers to remove.
           items:
@@ -2019,10 +2014,11 @@
         Values close to 1 signify higher confidence and we consider anything
         above the threshold of 0.8 to be actionable (the result and
         anti_detect_browser fields conveniently captures that fact)
     TamperingDetails:
       type: object
+      required: []
       properties:
         anomaly_score:
           type: number
           format: double
           minimum: 0
@@ -2121,10 +2117,11 @@
 
         All will not necessarily be returned in a response, some may be omitted
         if the 
 
         associated event does not have the required data, such as a linked_id.
+      required: []
       properties:
         distinct_ip:
           $ref: '#/components/schemas/VelocityData'
         distinct_linked_id:
           $ref: '#/components/schemas/VelocityData'
@@ -2212,10 +2209,11 @@
       type: object
       description: >
         Baseline measurement of canonical fonts rendered on the device. Numeric
         width metrics, in CSS pixels, for the canonical fonts collected by the
         agent.
+      required: []
       properties:
         default:
           type: number
           format: double
         serif:
@@ -2237,10 +2235,11 @@
           type: number
           format: double
     Emoji:
       type: object
       description: Bounding box metrics describing how the emoji glyph renders.
+      required: []
       properties:
         font:
           type: string
           description: Font family reported by the browser when drawing the emoji.
         width:
@@ -2270,27 +2269,22 @@
     Fonts:
       type: array
       description: List of fonts detected on the device.
       items:
         type: string
-      example:
-        - Arial Unicode MS
-        - Gill Sans
-        - Helvetica Neue
-        - Menlo
     DeviceMemory:
       type: integer
       format: int32
       minimum: 0
-      example: 8
       description: Rounded amount of RAM in gigabytes.
     Timezone:
       type: string
       description: Timezone identifier detected on the client.
     Canvas:
       type: object
       description: Canvas fingerprint containing winding flag plus geometry/text hashes.
+      required: []
       properties:
         winding:
           type: boolean
         geometry:
           type: string
@@ -2309,10 +2303,11 @@
         items:
           type: string
     WebGlExtensions:
       type: object
       description: Hashes of WebGL context attributes and extension support.
+      required: []
       properties:
         context_attributes:
           type: string
         parameters:
           type: string
@@ -2327,10 +2322,11 @@
           items:
             type: string
     WebGlBasics:
       type: object
       description: Render and vendor strings reported by the WebGL context.
+      required: []
       properties:
         version:
           type: string
         vendor:
           type: string
@@ -2351,10 +2347,11 @@
         type: integer
         format: int32
     TouchSupport:
       type: object
       description: Browser-reported touch capabilities.
+      required: []
       properties:
         touch_event:
           type: boolean
         touch_start:
           type: boolean
@@ -2430,10 +2427,11 @@
             type: string
           mimeTypes:
             type: array
             items:
               type: object
+              required: []
               properties:
                 type:
                   type: string
                 suffixes:
                   type: string
@@ -2462,11 +2460,10 @@
     BatteryLevel:
       type: integer
       format: int32
       minimum: 0
       maximum: 100
-      example: 75
       description: >-
         Battery charge level as a percentage (0-100). Available only for Android
         and iOS devices.
     BatteryLowPowerMode:
       type: boolean
@@ -2477,10 +2474,11 @@
       type: object
       description: >
         A curated subset of raw browser/device attributes that the API surface
         exposes. Each property contains a value or object with the data for the
         collected signal.
+      required: []
       properties:
         font_preferences:
           $ref: '#/components/schemas/FontPreferences'
         emoji:
           $ref: '#/components/schemas/Emoji'
@@ -2899,20 +2897,22 @@
             - browser
             - ios
             - android
     EventUpdate:
       type: object
+      required: []
       properties:
         linked_id:
           type: string
-          description: Linked Id value to assign to the existing event
+          description: Linked ID value to assign to the existing event
         tags:
           type: object
           description: >-
             A customer-provided value or an object that was sent with the
             identification request or updated later.
           additionalProperties: true
+          required: []
         suspect:
           type: boolean
           description: Suspect flag indicating observed suspicious or fraudulent event
           x-go-force-pointer: true
     EventSearch:

…rsion

mcnulty-fp · 2026-06-25T16:15:57Z

@copilot resolve the merge conflicts in this PR

# Conflicts: # schemas/components/schemas/identification/Device.yaml # schemas/components/schemas/identification/Os.yaml # schemas/components/schemas/identification/OsVersion.yaml # schemas/components/schemas/smartsignals/VpnMLScore.yaml

Copilot · 2026-06-25T16:19:13Z

@copilot resolve the merge conflicts in this PR

Resolved the merge conflicts by merging origin/main into this branch. The 4 conflicting files were resolved by keeping both the examples arrays from this branch and the updated inline-example descriptions from main.

mcnulty-fp · 2026-06-25T16:48:55Z

Copilot did resolve the merge conflicts but also committed a package-lock.json 🤔 Looks like we are missing an instruction in AGENTS.md to use pnpm. I went ahead and added that.

I forced pushed the branch to avoid having the package-lock.json in the history.

github-actions · 2026-06-25T16:49:09Z

🚀 Following releases will be created using changesets from this PR:

fingerprint-pro-server-api-openapi@3.4.0

Minor Changes

Add proxy, proxy_confidence, proxy_details, vpn, vpn_confidence, and vpn_methods to EdgeResponse (2d4f791)
events: Add device, os, and os_version to Event (7d9ed6a)
events: Add battery_level and battery_low_power_mode to RawDeviceAttributes (ba43bc1)
events: Add ml_prediction to vpn_methods (0939dc2)
events: Add vpn_ml_score to Event (0939dc2)
Added VPN mlScore and mlPrediction to v3 events and events search (2d17209)
events-search: Document 404 response for searchEvents operation (0939dc2)

mcnulty-fp

LGTM! I don't think any of the updates require a changeset

chore: sync OpenAPI schema

96fe09f

fingerprint-dx-team-actions-runner Bot requested review from JuroUhlar, TheUnderScorer, erayaydin, ilfa and mcnulty-fp as code owners June 24, 2026 16:50

fingerprint-dx-team-actions-runner Bot had a problem deploying to test June 24, 2026 16:50 Failure

fingerprint-dx-team-actions-runner Bot had a problem deploying to test June 24, 2026 21:36 Failure

This was referenced Jun 24, 2026

Add device, os, os_version to Event #388

Closed

Sync OpenAPI Schema (17429) #390

Closed

Sync OpenAPI Schema (17644) #391

Closed

Sync OpenAPI Schema (17569) #392

Merged

fix: drop empty required arrays during JSON schema validation conve…

5993d91

…rsion

JuroUhlar temporarily deployed to test June 25, 2026 09:13 — with GitHub Actions Inactive

Copilot started work on behalf of mcnulty-fp June 25, 2026 16:16 View session

Copilot finished work on behalf of mcnulty-fp June 25, 2026 16:19

mcnulty-fp force-pushed the sync-17700 branch from ad35b88 to 4bc24ce Compare June 25, 2026 16:46

mcnulty-fp temporarily deployed to test June 25, 2026 16:47 — with GitHub Actions Inactive

chore: add pnpm requirement to AGENTS.md

684a9b9

mcnulty-fp temporarily deployed to test June 25, 2026 16:48 — with GitHub Actions Inactive

mcnulty-fp approved these changes Jun 25, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sync OpenAPI Schema (17700)#397

Sync OpenAPI Schema (17700)#397
fingerprint-dx-team-actions-runner[bot] wants to merge 4 commits into
mainfrom
sync-17700

fingerprint-dx-team-actions-runner Bot commented Jun 24, 2026

Uh oh!

fingerprint-dx-team-actions-runner Bot commented Jun 24, 2026

Uh oh!

changeset-bot Bot commented Jun 24, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 24, 2026 •

edited

Loading

Uh oh!

mcnulty-fp commented Jun 25, 2026

Uh oh!

Copilot AI commented Jun 25, 2026

Uh oh!

mcnulty-fp commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

mcnulty-fp left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

fingerprint-dx-team-actions-runner Bot commented Jun 24, 2026

Changes

Uh oh!

fingerprint-dx-team-actions-runner Bot commented Jun 24, 2026

Uh oh!

changeset-bot Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Schema Diff vs Published Schemas

fingerprint-server-api-v4-normalized.yaml

fingerprint-server-api-v4-with-examples.yaml

fingerprint-server-api-v4.yaml

Uh oh!

mcnulty-fp commented Jun 25, 2026

Uh oh!

Copilot AI commented Jun 25, 2026

Uh oh!

mcnulty-fp commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

🚀 Following releases will be created using changesets from this PR:

fingerprint-pro-server-api-openapi@3.4.0

Minor Changes

Uh oh!

mcnulty-fp left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot Bot commented Jun 24, 2026 •

edited

Loading

github-actions Bot commented Jun 24, 2026 •

edited

Loading

`fingerprint-server-api-v4-normalized.yaml`

`fingerprint-server-api-v4-with-examples.yaml`

`fingerprint-server-api-v4.yaml`