@fingerprintjs/fingerprintjs-pro-server-api
Advanced tools
Changelog
6.0.0
The underlying Server API hasn’t changed, but we made SDK type and class generation more precise, resulting in small breaking changes for the SDK itself. This change should make the SDK API a lot more stable going forward
EventUpdateRequest
type to EventsUpdateRequest
(54b92b2)BrowserDetails
field botProbability
.IdentificationConfidence
field score
type format: float
-> double
.RawDeviceAttributeError
field name
optional .RawDeviceAttributeError
field message
optional .EventsResponse
field error
.
ErrorResponse
model.HighActivity
field dailyRequests
type format: number
-> int64
.Tampering
field anomalyScore
type format: double
.Webhook
fields optional: visitorId
, visitorFound
, firstSeenAt
, lastSeenAt
, browserDetails
, incognito
.WebhookClonedApp
field result
optional.WebhookDeveloperTools
field result
optional.WebhookEmulator
field result
optional.WebhookFactoryReset
fields time
and timestamp
optional.WebhookFrida
field result
optional.WebhookHighActivity
field dailyRequests
type format: number
-> int64
.WebhookIPBlocklist
fields result
and details
optional.WebhookJailbroken
field result
optional.WebhookLocationSpoofing
field result
optional.WebhookPrivacySettings
field result
optional.WebhookProxy
field result
optional.WebhookRemoteControl
field result
optional.WebhookRootApps
field result
optional.WebhookSuspectScore
field result
optional.WebhookTampering
fields result
, anomalyScore
and antiDetectBrowser
optional.WebhookTampering
field anomalyScore
type format: double
.WebhookTor
field result
optional.WebhookVelocity
fields optional: distinctIp
, distinctLinkedId
, distinctCountry
, events
, ipEvents
, distinctIpByLinkedId
, distinctVisitorIdByLinkedId
.WebhookVirtualMachine
field result
optional.WebhookVPN
fields optional: result
, confidence
, originTimezone
, methods
. (68b89bf)BotdResult
-> Botd
.BotdDetectionResult
-> BotdBot
:
result
type as BotdBotResult
.ClonedAppResult
-> ClonedApp
.DeveloperToolsResult
-> DeveloperTools
.EmulatorResult
-> Emulator
.ErrorCommon403Response
, ErrorCommon429Response
, ErrorEvent404Response
, TooManyRequestsResponse
, ErrorVisits403
, ErrorUpdateEvent400Response
, ErrorUpdateEvent409Response
, ErrorVisitor400Response
, ErrorVisitor404Response
, IdentificationError
, ProductError
.ErrorResponse
and ErrorPlainResponse
.
ErrorPlainResponse
has a different format { "error": string }
and it is used only in GET /visitors
.error
type as Error
.error.code
type as ErrorCode
.EventResponse
-> EventsGetResponse
.EventUpdateRequest
-> EventsUpdateRequest
.FactoryResetResult
-> FactoryReset
.FridaResult
-> Frida
.IPLocation
-> Geolocation
:
IPLocationCity
-> GeolocationCity
.subdivisions
type as GeolocationSubdivisions
.Location
-> GeolocationContinent
:GeolocationCountry
.Subdivision
-> GeolocationSubdivision
.HighActivityResult
-> HighActivity
.Confidence
-> IdentificationConfidence
.SeenAt
-> IdentificationSeenAt
.IncognitoResult
-> Incognito
.IpBlockListResult
-> IPBlocklist
:
details
type as IPBlocklistDetails
.IpInfoResult
-> IPInfo
:
IpInfoResultV4
-> IPInfoV4
.IpInfoResultV6
-> IPInfoV6
.ASN
-> IPInfoASN
.DataCenter
-> IPInfoDataCenter
.JailbrokenResult
-> Jailbroken
.LocationSpoofingResult
-> LocationSpoofing
.PrivacySettingsResult
-> PrivacySettings
.ProductsResponse
-> Products
:
ProductsResponseIdentification
-> ProductIdentification
, ProductsResponseIdentificationData
-> Identification
, ProductsResponseBotd
-> ProductBotd
, SignalResponseRootApps
-> ProductRootApps
, SignalResponseEmulator
-> ProductEmulator
, SignalResponseIpInfo
-> ProductIPInfo
, SignalResponseIpBlocklist
-> ProductIPBlocklist
, SignalResponseTor
-> ProductTor
, SignalResponseVpn
-> ProductVPN
, SignalResponseProxy
-> ProductProxy
, ProxyResult
-> Proxy
, SignalResponseIncognito
-> ProductIncognito
, SignalResponseTampering
-> ProductTampering
, SignalResponseClonedApp
-> ProductClonedApp
, SignalResponseFactoryReset
-> ProductFactoryReset
, SignalResponseJailbroken
-> ProductJailbroken
, SignalResponseFrida
-> ProductFrida
, SignalResponsePrivacySettings
-> ProductPrivacySettings
, SignalResponseVirtualMachine
-> ProductVirtualMachine
, SignalResponseRawDeviceAttributes
-> ProductRawDeviceAttributes
, RawDeviceAttributesResultValue
-> RawDeviceAttributes
, SignalResponseHighActivity
-> ProductHighActivity
, SignalResponseLocationSpoofing
-> ProductLocationSpoofing
, SignalResponseSuspectScore
-> ProductSuspectScore
, SignalResponseRemoteControl
-> ProductRemoteControl
, SignalResponseVelocity
-> ProductVelocity
, SignalResponseDeveloperTools
-> ProductDeveloperTools
.identification.data
type as Identification
.RawDeviceAttributesResult
-> RawDeviceAttributes
:
RawDeviceAttribute
.error
type as RawDeviceAttributeError
.RemoteControlResult
-> RemoteControl
.RootAppsResult
-> RootApps
.SuspectScoreResult
-> SuspectScore
.Tag
.TamperingResult
-> Tampering
.TorResult
-> Tor
.VelocityResult
-> Velocity
:
VelocityIntervals
-> VelocityData
.VelocityIntervalResult
-> VelocityIntervals
.VirtualMachineResult
-> VirtualMachine
.Visit
field ipLocation
type DeprecatedIPLocation
-> DeprecatedGeolocation
.
DeprecatedIPLocationCity
use common GeolocationCity
Response
-> VisitorsGetResponse
.
ResponseVisits
VpnResult
-> VPN
.
confidence
type as VPNConfidence
.methods
type as VPNMethods
.WebhookVisit
-> Webhook
.
WebhookRootApps
, WebhookEmulator
, WebhookIPInfo
, WebhookIPBlocklist
, WebhookTor
, WebhookVPN
, WebhookProxy
, WebhookTampering
, WebhookClonedApp
, WebhookFactoryReset
, WebhookJailbroken
, WebhookFrida
, WebhookPrivacySettings
, WebhookVirtualMachine
, WebhookRawDeviceAttributes
, WebhookHighActivity
, WebhookLocationSpoofing
, WebhookSuspectScore
, WebhookRemoteControl
, WebhookVelocity
, WebhookDeveloperTools
. (68b89bf)isEventError
, isUpdateEventError
, etc. (a17b73f)TooManyRequestsError
and RequestError
(6f4076e)VisitWebhook
type to Webhook
(980bab0)ipEvents
, distinctIpByLinkedId
, and distinctVisitorIdByLinkedId
fields to the velocity
Smart Signal. (68b89bf)GeolocationCity
field name
required.GeolocationSubdivision
field isoCode
required.GeolocationSubdivision
field name
required.IPInfoASN
field name
required .IPInfoDataCenter
field name
required.IdentificationConfidence
field comment
.Botd
field meta
.Identification
field components
.VPN
field originCountry
required.Visit
field components
.Webhook
field components
. (68b89bf)ipv4
format from ip
field in Botd
, Identification
, Visit
and Webhook
models. (b707bfa)Changelog
6.0.0-test.0
EventUpdateRequest
type to EventsUpdateRequest
(54b92b2)BrowserDetails
field botProbability
.IdentificationConfidence
field score
type format: float
-> double
.RawDeviceAttributeError
field name
optional .RawDeviceAttributeError
field message
optional .EventsResponse
field error
.
ErrorResponse
model.HighActivity
field dailyRequests
type format: number
-> int64
.Tampering
field anomalyScore
type format: double
.Webhook
fields optional: visitorId
, visitorFound
, firstSeenAt
, lastSeenAt
, browserDetails
, incognito
.WebhookClonedApp
field result
optional.WebhookDeveloperTools
field result
optional.WebhookEmulator
field result
optional.WebhookFactoryReset
fields time
and timestamp
optional.WebhookFrida
field result
optional.WebhookHighActivity
field dailyRequests
type format: number
-> int64
.WebhookIPBlocklist
fields result
and details
optional.WebhookJailbroken
field result
optional.WebhookLocationSpoofing
field result
optional.WebhookPrivacySettings
field result
optional.WebhookProxy
field result
optional.WebhookRemoteControl
field result
optional.WebhookRootApps
field result
optional.WebhookSuspectScore
field result
optional.WebhookTampering
fields result
, anomalyScore
and antiDetectBrowser
optional.WebhookTampering
field anomalyScore
type format: double
.WebhookTor
field result
optional.WebhookVelocity
fields optional: distinctIp
, distinctLinkedId
, distinctCountry
, events
, ipEvents
, distinctIpByLinkedId
, distinctVisitorIdByLinkedId
.WebhookVirtualMachine
field result
optional.WebhookVPN
fields optional: result
, confidence
, originTimezone
, methods
. (68b89bf)BotdResult
-> Botd
.BotdDetectionResult
-> BotdBot
:
result
type as BotdBotResult
.ClonedAppResult
-> ClonedApp
.DeveloperToolsResult
-> DeveloperTools
.EmulatorResult
-> Emulator
.ErrorCommon403Response
, ErrorCommon429Response
, ErrorEvent404Response
, TooManyRequestsResponse
, ErrorVisits403
, ErrorUpdateEvent400Response
, ErrorUpdateEvent409Response
, ErrorVisitor400Response
, ErrorVisitor404Response
, IdentificationError
, ProductError
.ErrorResponse
and ErrorPlainResponse
.
ErrorPlainResponse
has a different format { "error": string }
and it is used only in GET /visitors
.error
type as Error
.error.code
type as ErrorCode
.EventResponse
-> EventsGetResponse
.EventUpdateRequest
-> EventsUpdateRequest
.FactoryResetResult
-> FactoryReset
.FridaResult
-> Frida
.IPLocation
-> Geolocation
:
IPLocationCity
-> GeolocationCity
.subdivisions
type as GeolocationSubdivisions
.Location
-> GeolocationContinent
:GeolocationCountry
.Subdivision
-> GeolocationSubdivision
.HighActivityResult
-> HighActivity
.Confidence
-> IdentificationConfidence
.SeenAt
-> IdentificationSeenAt
.IncognitoResult
-> Incognito
.IpBlockListResult
-> IPBlocklist
:
details
type as IPBlocklistDetails
.IpInfoResult
-> IPInfo
:
IpInfoResultV4
-> IPInfoV4
.IpInfoResultV6
-> IPInfoV6
.ASN
-> IPInfoASN
.DataCenter
-> IPInfoDataCenter
.JailbrokenResult
-> Jailbroken
.LocationSpoofingResult
-> LocationSpoofing
.PrivacySettingsResult
-> PrivacySettings
.ProductsResponse
-> Products
:
ProductsResponseIdentification
-> ProductIdentification
, ProductsResponseIdentificationData
-> Identification
, ProductsResponseBotd
-> ProductBotd
, SignalResponseRootApps
-> ProductRootApps
, SignalResponseEmulator
-> ProductEmulator
, SignalResponseIpInfo
-> ProductIPInfo
, SignalResponseIpBlocklist
-> ProductIPBlocklist
, SignalResponseTor
-> ProductTor
, SignalResponseVpn
-> ProductVPN
, SignalResponseProxy
-> ProductProxy
, ProxyResult
-> Proxy
, SignalResponseIncognito
-> ProductIncognito
, SignalResponseTampering
-> ProductTampering
, SignalResponseClonedApp
-> ProductClonedApp
, SignalResponseFactoryReset
-> ProductFactoryReset
, SignalResponseJailbroken
-> ProductJailbroken
, SignalResponseFrida
-> ProductFrida
, SignalResponsePrivacySettings
-> ProductPrivacySettings
, SignalResponseVirtualMachine
-> ProductVirtualMachine
, SignalResponseRawDeviceAttributes
-> ProductRawDeviceAttributes
, RawDeviceAttributesResultValue
-> RawDeviceAttributes
, SignalResponseHighActivity
-> ProductHighActivity
, SignalResponseLocationSpoofing
-> ProductLocationSpoofing
, SignalResponseSuspectScore
-> ProductSuspectScore
, SignalResponseRemoteControl
-> ProductRemoteControl
, SignalResponseVelocity
-> ProductVelocity
, SignalResponseDeveloperTools
-> ProductDeveloperTools
.identification.data
type as Identification
.RawDeviceAttributesResult
-> RawDeviceAttributes
:
RawDeviceAttribute
.error
type as RawDeviceAttributeError
.RemoteControlResult
-> RemoteControl
.RootAppsResult
-> RootApps
.SuspectScoreResult
-> SuspectScore
.Tag
.TamperingResult
-> Tampering
.TorResult
-> Tor
.VelocityResult
-> Velocity
:
VelocityIntervals
-> VelocityData
.VelocityIntervalResult
-> VelocityIntervals
.VirtualMachineResult
-> VirtualMachine
.Visit
field ipLocation
type DeprecatedIPLocation
-> DeprecatedGeolocation
.
DeprecatedIPLocationCity
use common GeolocationCity
Response
-> VisitorsGetResponse
.
ResponseVisits
VpnResult
-> VPN
.
confidence
type as VPNConfidence
.methods
type as VPNMethods
.WebhookVisit
-> Webhook
.
WebhookRootApps
, WebhookEmulator
, WebhookIPInfo
, WebhookIPBlocklist
, WebhookTor
, WebhookVPN
, WebhookProxy
, WebhookTampering
, WebhookClonedApp
, WebhookFactoryReset
, WebhookJailbroken
, WebhookFrida
, WebhookPrivacySettings
, WebhookVirtualMachine
, WebhookRawDeviceAttributes
, WebhookHighActivity
, WebhookLocationSpoofing
, WebhookSuspectScore
, WebhookRemoteControl
, WebhookVelocity
, WebhookDeveloperTools
. (68b89bf)isEventError
, isUpdateEventError
, etc. (a17b73f)TooManyRequestsError
and RequestError
(6f4076e)VisitWebhook
type to Webhook
(980bab0)ipEvents
, distinctIpByLinkedId
, and distinctVisitorIdByLinkedId
fields to the velocity
Smart Signal. (68b89bf)GeolocationCity
field name
required.GeolocationSubdivision
field isoCode
required.GeolocationSubdivision
field name
required.IPInfoASN
field name
required .IPInfoDataCenter
field name
required.IdentificationConfidence
field comment
.Botd
field meta
.Identification
field components
.VPN
field originCountry
required.Visit
field components
.Webhook
field components
. (68b89bf)ipv4
format from ip
field in Botd
, Identification
, Visit
and Webhook
models. (b707bfa)Changelog
5.0.0 (2024-08-12)
ErrorVisitsDelete400Response
to ErrorVisitor400Response
ErrorVisitsDelete404ResponseError
to ErrorVisitor404ResponseError
ErrorVisitsDelete404Response
to `ErrorVisitor404Responsstatus
in error object to statusCode
responseBody
property, e.g: error.responseBody