sdk

package

v7.1.0 Latest Latest Go to latest Published: Nov 26, 2024 License: MIT Imports: 10 Imported by: 1

Documentation ¶

Overview ¶

* Fingerprint Pro Server API * * Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. * * API version: 3 * Contact: support@fingerprint.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Constants
Variables
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type ApiError
- func WrapWithApiError(err error) *ApiError
- func (e ApiError) Body() []byte
- func (e ApiError) Code() ErrorCode
- func (e ApiError) Error() string
- func (e ApiError) Model() any
type BasicAuth
type Botd
type BotdBot
type BotdBotResult
type BrowserDetails
type ClonedApp
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
- func (c *Configuration) ChangeBasePath(path string)
- func (c *Configuration) ChangeRegion(region Region)
- func (c *Configuration) GetBasePath() string
- func (c *Configuration) GetRegion() Region
type DeprecatedGeolocation
type DeveloperTools
type Emulator
type Error
type ErrorCode
type ErrorPlainResponse
type ErrorResponse
type EventsGetResponse
type EventsUpdateRequest
type FactoryReset
type FingerprintApiGetVisitsOpts
- func (o *FingerprintApiGetVisitsOpts) ToUrlValuesMap() map[string]any
type FingerprintApiService
- func (f *FingerprintApiService) DeleteVisitorData(ctx context.Context, visitorId string) (*http.Response, Error)
- func (f *FingerprintApiService) GetEvent(ctx context.Context, requestId string) (EventsGetResponse, *http.Response, Error)
- func (f *FingerprintApiService) GetRelatedVisitors(ctx context.Context, visitorId string) (RelatedVisitorsResponse, *http.Response, Error)
- func (f *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, opts *FingerprintApiGetVisitsOpts) (VisitorsGetResponse, *http.Response, Error)
- func (f *FingerprintApiService) UpdateEvent(ctx context.Context, body EventsUpdateRequest, requestId string) (*http.Response, Error)
type FingerprintApiServiceInterface
type Frida
type Geolocation
type GeolocationCity
type GeolocationContinent
type GeolocationCountry
type GeolocationSubdivision
type HighActivity
type Identification
type IdentificationConfidence
type IdentificationSeenAt
type Incognito
type IpBlocklist
type IpBlocklistDetails
type IpInfo
type IpInfoAsn
type IpInfoDataCenter
type IpInfoV4
type IpInfoV6
type Jailbroken
type LocationSpoofing
type ModelError
type ModelMap
type Object
type PrivacySettings
type ProductBotd
type ProductClonedApp
type ProductDeveloperTools
type ProductEmulator
type ProductFactoryReset
type ProductFrida
type ProductHighActivity
type ProductIdentification
type ProductIncognito
type ProductIpBlocklist
type ProductIpInfo
type ProductJailbroken
type ProductLocationSpoofing
type ProductPrivacySettings
type ProductProxy
type ProductRawDeviceAttributes
type ProductRemoteControl
type ProductRootApps
type ProductSuspectScore
type ProductTampering
type ProductTor
type ProductVelocity
type ProductVirtualMachine
type ProductVpn
type Products
type Proxy
type RawDeviceAttribute
type RawDeviceAttributeError
type Region
type RelatedVisitor
type RelatedVisitorsResponse
type RemoteControl
type RootApps
type SuspectScore
type Tampering
type TooManyRequestsError
- func (e *TooManyRequestsError) Body() []byte
- func (e *TooManyRequestsError) Code() ErrorCode
- func (e *TooManyRequestsError) Error() string
- func (e *TooManyRequestsError) Model() any
- func (e *TooManyRequestsError) RetryAfter() int64
type Tor
type Velocity
type VelocityData
type VelocityIntervals
type VirtualMachine
type Visit
type VisitorsGetResponse
type Vpn
type VpnConfidence
type VpnMethods
type Webhook
type WebhookClonedApp
type WebhookDeveloperTools
type WebhookEmulator
type WebhookFactoryReset
type WebhookFrida
type WebhookHighActivity
type WebhookIpBlocklist
type WebhookIpInfo
type WebhookJailbroken
type WebhookLocationSpoofing
type WebhookPrivacySettings
type WebhookProxy
type WebhookRemoteControl
type WebhookRootApps
type WebhookSuspectScore
type WebhookTampering
type WebhookTor
type WebhookVelocity
type WebhookVirtualMachine
type WebhookVpn

Constants ¶

View Source

const IntegrationInfo = "fingerprint-pro-server-go-sdk/7.1.0"

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

This section is empty.

Types ¶

type APIClient ¶

type APIClient struct {
	FingerprintApi FingerprintApiServiceInterface
	// contains filtered or unexported fields
}

APIClient manages communication with the Fingerprint Pro Server API API v3 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ApiError ¶

type ApiError struct {
	// contains filtered or unexported fields
}

ApiError Provides access to the body, error and model on returned errors.

func WrapWithApiError ¶

func WrapWithApiError(err error) *ApiError

func (ApiError) Body ¶

func (e ApiError) Body() []byte

func (ApiError) Code ¶

func (e ApiError) Code() ErrorCode

func (ApiError) Error ¶

func (e ApiError) Error() string

Error returns non-empty string if there was an error.

func (ApiError) Model ¶

func (e ApiError) Model() any

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Botd ¶

type Botd struct {
	Bot  *BotdBot  `json:"bot"`
	Meta *ModelMap `json:"meta,omitempty"`
	// A customer-provided id that was sent with the request.
	LinkedId string `json:"linkedId,omitempty"`
	// Page URL from which the request was sent.
	Url string `json:"url"`
	// IP address of the requesting browser or bot.
	Ip string `json:"ip"`
	// Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible.
	Time      *time.Time `json:"time"`
	UserAgent string     `json:"userAgent"`
	// Unique identifier of the user's request.
	RequestId string `json:"requestId"`
}

Contains all the information from Bot Detection product

type BotdBot ¶

type BotdBot struct {
	Result *BotdBotResult `json:"result"`
	Type_  string         `json:"type,omitempty"`
}

Stores bot detection result

type BotdBotResult ¶

type BotdBotResult string

BotdBotResult : Bot detection result: * `notDetected` - the visitor is not a bot * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on

const (
	NOT_DETECTED BotdBotResult = "notDetected"
	GOOD         BotdBotResult = "good"
	BAD          BotdBotResult = "bad"
)

List of BotdBotResult

type BrowserDetails ¶

type BrowserDetails struct {
	BrowserName         string `json:"browserName"`
	BrowserMajorVersion string `json:"browserMajorVersion"`
	BrowserFullVersion  string `json:"browserFullVersion"`
	Os                  string `json:"os"`
	OsVersion           string `json:"osVersion"`
	Device              string `json:"device"`
	UserAgent           string `json:"userAgent"`
}

type ClonedApp ¶

type ClonedApp struct {
	// Android specific cloned application detection. There are 2 values:    * `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected).   * `false` - No signs of cloned application detected or the client is not Android.
	Result bool `json:"result"`
}

type Configuration ¶

type Configuration struct {
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
	// contains filtered or unexported fields
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

func (*Configuration) ChangeBasePath ¶

func (c *Configuration) ChangeBasePath(path string)

ChangeBasePath Change base path to allow switching to mocks

func (*Configuration) ChangeRegion ¶

func (c *Configuration) ChangeRegion(region Region)

ChangeRegion Changes region and sets basePath for it

func (*Configuration) GetBasePath ¶

func (c *Configuration) GetBasePath() string

func (*Configuration) GetRegion ¶

func (c *Configuration) GetRegion() Region

type DeprecatedGeolocation ¶

type DeprecatedGeolocation struct {
	// The IP address is likely to be within this radius (in km) of the specified location.
	AccuracyRadius int32                     `json:"accuracyRadius,omitempty"`
	Latitude       float64                   `json:"latitude,omitempty"`
	Longitude      float64                   `json:"longitude,omitempty"`
	PostalCode     string                    `json:"postalCode,omitempty"`
	Timezone       string                    `json:"timezone,omitempty"`
	City           *GeolocationCity          `json:"city,omitempty"`
	Country        *GeolocationCountry       `json:"country,omitempty"`
	Continent      *GeolocationContinent     `json:"continent,omitempty"`
	Subdivisions   *[]GeolocationSubdivision `json:"subdivisions,omitempty"`
}

This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.

type DeveloperTools ¶

type DeveloperTools struct {
	// `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise.
	Result bool `json:"result"`
}

type Emulator ¶

type Emulator struct {
	// Android specific emulator detection. There are 2 values:    * `true` - Emulated environment detected (e.g. launch inside of AVD).    * `false` - No signs of emulated environment detected or the client is not Android.
	Result bool `json:"result"`
}

type Error ¶

type Error interface {
	error

	// Body returns the raw bytes of the response, if available.
	Body() []byte

	// Code returns the error code.
	Code() ErrorCode

	// Model returns the unpacked model of the error. When error was created with WrapWithApiError, it returns the original error.
	// If error was thrown after we get the HTTP Response, it contains model parsed from response body.
	Model() any
}

Error defines base interface of all errors returned by this SDK

type ErrorCode ¶

type ErrorCode string

ErrorCode : Error code: * `RequestCannotBeParsed` - the query parameters or JSON payload contains some errors that prevented us from parsing it (wrong type/surpassed limits). * `TokenRequired` - `Auth-API-Key` header is missing or empty. * `TokenNotFound` - no Fingerprint application found for specified secret key. * `SubscriptionNotActive` - Fingerprint application is not active. * `WrongRegion` - server and application region differ. * `FeatureNotEnabled` - this feature (for example, Delete API) is not enabled for your application. * `RequestNotFound` - the specified request ID was not found. It never existed, expired, or it has been deleted. * `VisitorNotFound` - The specified visitor ID was not found. It never existed or it may have already been deleted. * `TooManyRequests` - the limit on secret API key requests per second has been exceeded. * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded. * `StateNotReady` - The event specified with request id is not ready for updates yet. Try again. This error happens in rare cases when update API is called immediately after receiving the request id on the client. In case you need to send information right away, we recommend using the JS agent API instead. * `Failed` - internal server error.

const (
	REQUEST_CANNOT_BE_PARSED ErrorCode = "RequestCannotBeParsed"
	TOKEN_REQUIRED           ErrorCode = "TokenRequired"
	TOKEN_NOT_FOUND          ErrorCode = "TokenNotFound"
	SUBSCRIPTION_NOT_ACTIVE  ErrorCode = "SubscriptionNotActive"
	WRONG_REGION             ErrorCode = "WrongRegion"
	FEATURE_NOT_ENABLED      ErrorCode = "FeatureNotEnabled"
	REQUEST_NOT_FOUND        ErrorCode = "RequestNotFound"
	VISITOR_NOT_FOUND        ErrorCode = "VisitorNotFound"
	TOO_MANY_REQUESTS        ErrorCode = "TooManyRequests"
	TOOMANYREQUESTS429       ErrorCode = "429 Too Many Requests"
	STATE_NOT_READY          ErrorCode = "StateNotReady"
	FAILED                   ErrorCode = "Failed"
)

List of ErrorCode

type ErrorPlainResponse ¶

type ErrorPlainResponse struct {
	Error_ string `json:"error"`
}

type ErrorResponse ¶

type ErrorResponse struct {
	Error_ *ModelError `json:"error"`
}

type EventsGetResponse ¶

type EventsGetResponse struct {
	Products *Products `json:"products"`
}

Contains results from all activated products - Fingerprint Pro, Bot Detection, and others.

type EventsUpdateRequest ¶

type EventsUpdateRequest struct {
	// LinkedID value to assign to the existing event
	LinkedId string    `json:"linkedId,omitempty"`
	Tag      *ModelMap `json:"tag,omitempty"`
	// Suspect flag indicating observed suspicious or fraudulent event
	Suspect bool `json:"suspect,omitempty"`
}

type FactoryReset ¶

type FactoryReset struct {
	// Indicates the time (in UTC) of the most recent factory reset that happened on the **mobile device**.  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 UTC). See [Factory Reset Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) to learn more about this Smart Signal.
	Time *time.Time `json:"time"`
	// This field is just another representation of the value in the `time` field. The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time.
	Timestamp int64 `json:"timestamp"`
}

type FingerprintApiGetVisitsOpts ¶

type FingerprintApiGetVisitsOpts struct {
	RequestId     string
	LinkedId      string
	Limit         int32
	PaginationKey string
	Before        int64
}

func (*FingerprintApiGetVisitsOpts) ToUrlValuesMap ¶

func (o *FingerprintApiGetVisitsOpts) ToUrlValuesMap() map[string]any

type FingerprintApiService ¶

type FingerprintApiService struct {
	// contains filtered or unexported fields
}

func (*FingerprintApiService) DeleteVisitorData ¶

func (f *FingerprintApiService) DeleteVisitorData(ctx context.Context, visitorId string) (*http.Response, Error)

func (*FingerprintApiService) GetEvent ¶

func (f *FingerprintApiService) GetEvent(ctx context.Context, requestId string) (EventsGetResponse, *http.Response, Error)

func (*FingerprintApiService) GetRelatedVisitors ¶

func (f *FingerprintApiService) GetRelatedVisitors(ctx context.Context, visitorId string) (RelatedVisitorsResponse, *http.Response, Error)

func (*FingerprintApiService) GetVisits ¶

func (f *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, opts *FingerprintApiGetVisitsOpts) (VisitorsGetResponse, *http.Response, Error)

func (*FingerprintApiService) UpdateEvent ¶

func (f *FingerprintApiService) UpdateEvent(ctx context.Context, body EventsUpdateRequest, requestId string) (*http.Response, Error)

type FingerprintApiServiceInterface ¶

type FingerprintApiServiceInterface interface {
	/*
	   FingerprintApiService Delete data by visitor ID
	   Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. ### Which data is deleted? - Browser (or device) properties - Identification requests made from this browser (or device)  #### Browser (or device) properties - Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it. - Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Application](https://dev.fingerprint.com/docs/glossary#fingerprint-application).  #### Identification requests made from this browser (or device) - Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://dev.fingerprint.com/docs/regions#data-retention). - Upon request to delete, the identification requests that were made by this browser   - Within the past 10 days are deleted within 24 hrs.   - Outside of 10 days are allowed to purge as per your data retention period.  ### Corollary After requesting to delete a visitor ID, - If the same browser (or device) requests to identify, it will receive a different visitor ID. - If you request [`/events` API](https://dev.fingerprint.com/reference/getevent) with a `request_id` that was made outside of the 10 days, you will still receive a valid response. - If you request [`/visitors` API](https://dev.fingerprint.com/reference/getvisits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days.  ### Interested? Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.
	    * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	    * @param visitorId The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) you want to delete.

	*/
	DeleteVisitorData(ctx context.Context, visitorId string) (*http.Response, Error)

	/*
	   FingerprintApiService Get event by request ID
	   Get a detailed analysis of an individual identification event, including Smart Signals.  Please note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform. It is highly recommended that you **ignore** the mobile signals for such requests.   Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.
	    * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	    * @param requestId The unique [identifier](https://dev.fingerprint.com/reference/get-function#requestid) of each identification request.
	       @return EventsGetResponse
	*/
	GetEvent(ctx context.Context, requestId string) (EventsGetResponse, *http.Response, Error)

	/*
	   FingerprintApiService Get Related Visitors
	   Related visitors API lets you link web visits and in-app browser visits that originated from the same mobile device. It searches the past 6 months of identification events to find the visitor IDs that belong to the same mobile device as the given visitor ID.  ⚠️ Please note that this API is not enabled by default and is billable separately. ⚠️  If you would like to use Related visitors API, please contact our [support team](https://fingerprint.com/support). To learn more, see [Related visitors API reference](https://dev.fingerprint.com/reference/related-visitors-api).
	    * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	    * @param visitorId The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device.
	       @return RelatedVisitorsResponse
	*/
	GetRelatedVisitors(ctx context.Context, visitorId string) (RelatedVisitorsResponse, *http.Response, Error)

	/*
	   FingerprintApiService Get visits by visitor ID
	   Get a history of visits (identification events) for a specific `visitorId`. Use the `visitorId` as a URL path parameter. Only information from the _Identification_ product is returned.  #### Headers  * `Retry-After` — Present in case of `429 Too many requests`. Indicates how long you should wait before making a follow-up request. The value is non-negative decimal integer indicating the seconds to delay after the response is received.
	    * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	    * @param visitorId Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro.
	    * @param optional nil or *FingerprintApiGetVisitsOpts - Optional Parameters:
	        * @param "RequestId" (string) -  Filter visits by `requestId`.   Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/reference/get-function#requestid). When you filter visits by `requestId`, only one visit will be returned.
	    * @param "LinkedId" (string) -  Filter visits by your custom identifier.   You can use [`linkedId`](https://dev.fingerprint.com/reference/get-function#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier.
	    * @param "Limit" (int32) -  Limit scanned results.   For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first). By default, the most recent 100 visits are scanned, the maximum is 500.
	    * @param "PaginationKey" (string) -  Use `paginationKey` to get the next page of results.   When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results:  1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200` 2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j`  Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned.
	    * @param "Before" (int64) -  ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results.
	   @return VisitorsGetResponse
	*/
	GetVisits(ctx context.Context, visitorId string, opts *FingerprintApiGetVisitsOpts) (VisitorsGetResponse, *http.Response, Error)

	/*
	   FingerprintApiService Update an event with a given request ID
	   Change information in existing events specified by `requestId` or *flag suspicious events*.  When an event is created, it is assigned `linkedId` and `tag` submitted through the JS agent parameters. This information might not be available on the client so the Server API allows for updating the attributes after the fact.  **Warning** It's not possible to update events older than 10 days.
	    * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	    * @param body
	    * @param requestId The unique event [identifier](https://dev.fingerprint.com/reference/get-function#requestid).

	*/
	UpdateEvent(ctx context.Context, body EventsUpdateRequest, requestId string) (*http.Response, Error)
}

type Frida ¶

type Frida struct {
	// [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values:   * `true` - Frida detected   * `false` - No signs of Frida or the client is not a mobile device.
	Result bool `json:"result"`
}

type Geolocation ¶

type Geolocation struct {
	// The IP address is likely to be within this radius (in km) of the specified location.
	AccuracyRadius int32                     `json:"accuracyRadius,omitempty"`
	Latitude       float64                   `json:"latitude,omitempty"`
	Longitude      float64                   `json:"longitude,omitempty"`
	PostalCode     string                    `json:"postalCode,omitempty"`
	Timezone       string                    `json:"timezone,omitempty"`
	City           *GeolocationCity          `json:"city,omitempty"`
	Country        *GeolocationCountry       `json:"country,omitempty"`
	Continent      *GeolocationContinent     `json:"continent,omitempty"`
	Subdivisions   *[]GeolocationSubdivision `json:"subdivisions,omitempty"`
}

type GeolocationCity ¶

type GeolocationCity struct {
	Name string `json:"name"`
}

type GeolocationContinent ¶

type GeolocationContinent struct {
	Code string `json:"code"`
	Name string `json:"name"`
}

type GeolocationCountry ¶

type GeolocationCountry struct {
	Code string `json:"code"`
	Name string `json:"name"`
}

type GeolocationSubdivision ¶

type GeolocationSubdivision struct {
	IsoCode string `json:"isoCode"`
	Name    string `json:"name"`
}

type HighActivity ¶

type HighActivity struct {
	// Flag indicating if the request came from a high-activity visitor.
	Result bool `json:"result"`
	// Number of requests from the same visitor in the previous day.
	DailyRequests int64 `json:"dailyRequests,omitempty"`
}

type Identification ¶

type Identification struct {
	// String of 20 characters that uniquely identifies the visitor's browser.
	VisitorId string `json:"visitorId"`
	// Unique identifier of the user's request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito bool `json:"incognito"`
	// IP address of the requesting browser or bot.
	Ip         string                 `json:"ip"`
	IpLocation *DeprecatedGeolocation `json:"ipLocation,omitempty"`
	// A customer-provided id that was sent with the request.
	LinkedId string `json:"linkedId,omitempty"`
	// Field is `true` if you have previously set the `suspect` flag for this event using the [Server API Update event endpoint](https://dev.fingerprint.com/reference/updateevent).
	Suspect bool `json:"suspect,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format, when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible.
	Time *time.Time `json:"time"`
	// Page URL from which the request was sent.
	Url        string                    `json:"url"`
	Tag        *ModelMap                 `json:"tag"`
	Confidence *IdentificationConfidence `json:"confidence,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool                           `json:"visitorFound"`
	FirstSeenAt  *IdentificationSeenAt          `json:"firstSeenAt"`
	LastSeenAt   *IdentificationSeenAt          `json:"lastSeenAt"`
	Components   *map[string]RawDeviceAttribute `json:"components,omitempty"`
}

type IdentificationConfidence ¶

type IdentificationConfidence struct {
	// The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.
	Score float64 `json:"score"`
	// The revision name of the method used to calculate the Confidence score. This field is only present for customers who opted in to an alternative calculation method.
	Revision string `json:"revision,omitempty"`
	Comment  string `json:"comment,omitempty"`
}

type IdentificationSeenAt ¶

type IdentificationSeenAt struct {
	Global       *time.Time `json:"global"`
	Subscription *time.Time `json:"subscription"`
}

type Incognito ¶

type Incognito struct {
	// `true` if we detected incognito mode used in the browser, `false` otherwise.
	Result bool `json:"result"`
}

type IpBlocklist ¶

type IpBlocklist struct {
	// `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise.
	Result  bool                `json:"result"`
	Details *IpBlocklistDetails `json:"details"`
}

type IpBlocklistDetails ¶

type IpBlocklistDetails struct {
	// IP address was part of a known email spam attack (SMTP).
	EmailSpam bool `json:"emailSpam"`
	// IP address was part of a known network attack (SSH/HTTPS).
	AttackSource bool `json:"attackSource"`
}

type IpInfo ¶

type IpInfo struct {
	V4 *IpInfoV4 `json:"v4,omitempty"`
	V6 *IpInfoV6 `json:"v6,omitempty"`
}

Details about the request IP address. Has separate fields for v4 and v6 IP address versions.

type IpInfoAsn ¶

type IpInfoAsn struct {
	Asn     string `json:"asn"`
	Name    string `json:"name"`
	Network string `json:"network"`
}

type IpInfoDataCenter ¶

type IpInfoDataCenter struct {
	Result bool   `json:"result"`
	Name   string `json:"name"`
}

type IpInfoV4 ¶

type IpInfoV4 struct {
	Address     string            `json:"address"`
	Geolocation *Geolocation      `json:"geolocation"`
	Asn         *IpInfoAsn        `json:"asn,omitempty"`
	Datacenter  *IpInfoDataCenter `json:"datacenter,omitempty"`
}

type IpInfoV6 ¶

type IpInfoV6 struct {
	Address     string            `json:"address"`
	Geolocation *Geolocation      `json:"geolocation"`
	Asn         *IpInfoAsn        `json:"asn,omitempty"`
	Datacenter  *IpInfoDataCenter `json:"datacenter,omitempty"`
}

type Jailbroken ¶

type Jailbroken struct {
	// iOS specific jailbreak detection. There are 2 values:    * `true` - Jailbreak detected.   * `false` - No signs of jailbreak or the client is not iOS.
	Result bool `json:"result"`
}

type LocationSpoofing ¶

type LocationSpoofing struct {
	// Flag indicating whether the request came from a mobile device with location spoofing enabled.
	Result bool `json:"result"`
}

type ModelError ¶

type ModelError struct {
	Code    *ErrorCode `json:"code"`
	Message string     `json:"message"`
}

type ModelMap ¶

type ModelMap map[string]any

type Object ¶

type Object any

type PrivacySettings ¶

type PrivacySettings struct {
	// `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
	Result bool `json:"result"`
}

type ProductBotd ¶

type ProductBotd struct {
	Data   *Botd       `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductClonedApp ¶

type ProductClonedApp struct {
	Data   *ClonedApp  `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductDeveloperTools ¶

type ProductDeveloperTools struct {
	Data   *DeveloperTools `json:"data,omitempty"`
	Error_ *ModelError     `json:"error,omitempty"`
}

type ProductEmulator ¶

type ProductEmulator struct {
	Data   *Emulator   `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductFactoryReset ¶

type ProductFactoryReset struct {
	Data   *FactoryReset `json:"data,omitempty"`
	Error_ *ModelError   `json:"error,omitempty"`
}

type ProductFrida ¶

type ProductFrida struct {
	Data   *Frida      `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductHighActivity ¶

type ProductHighActivity struct {
	Data   *HighActivity `json:"data,omitempty"`
	Error_ *ModelError   `json:"error,omitempty"`
}

type ProductIdentification ¶

type ProductIdentification struct {
	Data   *Identification `json:"data,omitempty"`
	Error_ *ModelError     `json:"error,omitempty"`
}

type ProductIncognito ¶

type ProductIncognito struct {
	Data   *Incognito  `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductIpBlocklist ¶

type ProductIpBlocklist struct {
	Data   *IpBlocklist `json:"data,omitempty"`
	Error_ *ModelError  `json:"error,omitempty"`
}

type ProductIpInfo ¶

type ProductIpInfo struct {
	Data   *IpInfo     `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductJailbroken ¶

type ProductJailbroken struct {
	Data   *Jailbroken `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductLocationSpoofing ¶

type ProductLocationSpoofing struct {
	Data   *LocationSpoofing `json:"data,omitempty"`
	Error_ *ModelError       `json:"error,omitempty"`
}

type ProductPrivacySettings ¶

type ProductPrivacySettings struct {
	Data   *PrivacySettings `json:"data,omitempty"`
	Error_ *ModelError      `json:"error,omitempty"`
}

type ProductProxy ¶

type ProductProxy struct {
	Data   *Proxy      `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductRawDeviceAttributes ¶

type ProductRawDeviceAttributes struct {
	Data   *map[string]RawDeviceAttribute `json:"data,omitempty"`
	Error_ *ModelError                    `json:"error,omitempty"`
}

type ProductRemoteControl ¶

type ProductRemoteControl struct {
	Data   *RemoteControl `json:"data,omitempty"`
	Error_ *ModelError    `json:"error,omitempty"`
}

type ProductRootApps ¶

type ProductRootApps struct {
	Data   *RootApps   `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductSuspectScore ¶

type ProductSuspectScore struct {
	Data   *SuspectScore `json:"data,omitempty"`
	Error_ *ModelError   `json:"error,omitempty"`
}

type ProductTampering ¶

type ProductTampering struct {
	Data   *Tampering  `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductTor ¶

type ProductTor struct {
	Data   *Tor        `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductVelocity ¶

type ProductVelocity struct {
	Data   *Velocity   `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type ProductVirtualMachine ¶

type ProductVirtualMachine struct {
	Data   *VirtualMachine `json:"data,omitempty"`
	Error_ *ModelError     `json:"error,omitempty"`
}

type ProductVpn ¶

type ProductVpn struct {
	Data   *Vpn        `json:"data,omitempty"`
	Error_ *ModelError `json:"error,omitempty"`
}

type Products ¶

type Products struct {
	Identification      *ProductIdentification      `json:"identification,omitempty"`
	Botd                *ProductBotd                `json:"botd,omitempty"`
	RootApps            *ProductRootApps            `json:"rootApps,omitempty"`
	Emulator            *ProductEmulator            `json:"emulator,omitempty"`
	IpInfo              *ProductIpInfo              `json:"ipInfo,omitempty"`
	IpBlocklist         *ProductIpBlocklist         `json:"ipBlocklist,omitempty"`
	Tor                 *ProductTor                 `json:"tor,omitempty"`
	Vpn                 *ProductVpn                 `json:"vpn,omitempty"`
	Proxy               *ProductProxy               `json:"proxy,omitempty"`
	Incognito           *ProductIncognito           `json:"incognito,omitempty"`
	Tampering           *ProductTampering           `json:"tampering,omitempty"`
	ClonedApp           *ProductClonedApp           `json:"clonedApp,omitempty"`
	FactoryReset        *ProductFactoryReset        `json:"factoryReset,omitempty"`
	Jailbroken          *ProductJailbroken          `json:"jailbroken,omitempty"`
	Frida               *ProductFrida               `json:"frida,omitempty"`
	PrivacySettings     *ProductPrivacySettings     `json:"privacySettings,omitempty"`
	VirtualMachine      *ProductVirtualMachine      `json:"virtualMachine,omitempty"`
	RawDeviceAttributes *ProductRawDeviceAttributes `json:"rawDeviceAttributes,omitempty"`
	HighActivity        *ProductHighActivity        `json:"highActivity,omitempty"`
	LocationSpoofing    *ProductLocationSpoofing    `json:"locationSpoofing,omitempty"`
	SuspectScore        *ProductSuspectScore        `json:"suspectScore,omitempty"`
	RemoteControl       *ProductRemoteControl       `json:"remoteControl,omitempty"`
	Velocity            *ProductVelocity            `json:"velocity,omitempty"`
	DeveloperTools      *ProductDeveloperTools      `json:"developerTools,omitempty"`
}

Contains all information about the request identified by `requestId`, depending on the pricing plan (Pro, Pro Plus, Enterprise)

type Proxy ¶

type Proxy struct {
	// `true` if the request IP address is used by a public proxy provider, `false` otherwise.
	Result bool `json:"result"`
}

type RawDeviceAttribute ¶

type RawDeviceAttribute struct {
	Value  *Object                  `json:"value,omitempty"`
	Error_ *RawDeviceAttributeError `json:"error,omitempty"`
}

type RawDeviceAttributeError ¶

type RawDeviceAttributeError struct {
	Name    string `json:"name,omitempty"`
	Message string `json:"message,omitempty"`
}

type Region ¶

type Region string

const (
	RegionEU   Region = "eu"
	RegionUS   Region = "us"
	RegionAsia Region = "asia"
)

type RelatedVisitor ¶

type RelatedVisitor struct {
	// Visitor ID of a browser that originates from the same mobile device as the input visitor ID.
	VisitorId string `json:"visitorId"`
}

type RelatedVisitorsResponse ¶

type RelatedVisitorsResponse struct {
	RelatedVisitors []RelatedVisitor `json:"relatedVisitors"`
}

type RemoteControl ¶

type RemoteControl struct {
	// `true` if the request came from a machine being remotely controlled (e.g. TeamViewer), `false` otherwise.
	Result bool `json:"result"`
}

type RootApps ¶

type RootApps struct {
	// Android specific root management apps detection. There are 2 values:    * `true` - Root Management Apps detected (e.g. Magisk).   * `false` - No Root Management Apps detected or the client isn't Android.
	Result bool `json:"result"`
}

type SuspectScore ¶

type SuspectScore struct {
	// 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.  See more details here: https://dev.fingerprint.com/docs/suspect-score
	Result int32 `json:"result"`
}

type Tampering ¶

type Tampering struct {
	// Flag indicating browser tampering was detected. This happens when either of these conditions is true:   * There are inconsistencies in the browser configuration that cross our internal tampering thresholds (indicated by `anomalyScore`).   * The browser signature resembles one of \"anti-detect\" browsers specifically designed to evade identification and fingerprinting, for example, Incognition (indicated by `antiDetectBrowser`).
	Result bool `json:"result"`
	// Confidence score (`0.0 - 1.0`) for tampering detection:   * Values above `0.5` indicate that there was a tampering attempt.    * Values below `0.5` indicate genuine browsers.
	AnomalyScore float64 `json:"anomalyScore"`
	// Is `true` if the identified browser resembles one of \"anti-detect\" browsers, for example, Incognition.  Anti-detect browsers try to evade identification by masking or manipulating their fingerprint to imitate legitimate browser configurations.
	AntiDetectBrowser bool `json:"antiDetectBrowser"`
}

type TooManyRequestsError ¶

type TooManyRequestsError struct {
	// contains filtered or unexported fields
}

TooManyRequestsError Provides access to the body, error and model on returned 429 TooManyRequests error

func (*TooManyRequestsError) Body ¶

func (e *TooManyRequestsError) Body() []byte

func (*TooManyRequestsError) Code ¶

func (e *TooManyRequestsError) Code() ErrorCode

func (*TooManyRequestsError) Error ¶

func (e *TooManyRequestsError) Error() string

func (*TooManyRequestsError) Model ¶

func (e *TooManyRequestsError) Model() any

func (*TooManyRequestsError) RetryAfter ¶

func (e *TooManyRequestsError) RetryAfter() int64

type Tor ¶

type Tor struct {
	// `true` if the request IP address is a known tor exit node, `false` otherwise.
	Result bool `json:"result"`
}

type Velocity ¶

type Velocity struct {
	DistinctIp                  *VelocityData `json:"distinctIp"`
	DistinctLinkedId            *VelocityData `json:"distinctLinkedId"`
	DistinctCountry             *VelocityData `json:"distinctCountry"`
	Events                      *VelocityData `json:"events"`
	IpEvents                    *VelocityData `json:"ipEvents"`
	DistinctIpByLinkedId        *VelocityData `json:"distinctIpByLinkedId"`
	DistinctVisitorIdByLinkedId *VelocityData `json:"distinctVisitorIdByLinkedId"`
}

Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.

type VelocityData ¶

type VelocityData struct {
	Intervals *VelocityIntervals `json:"intervals,omitempty"`
}

type VelocityIntervals ¶

type VelocityIntervals struct {
	Var5m int32 `json:"5m"`
	Var1h int32 `json:"1h"`
	// The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events“ for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.
	Var24h int32 `json:"24h,omitempty"`
}

Is absent if the velocity data could not be generated for the visitor ID.

type VirtualMachine ¶

type VirtualMachine struct {
	// `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
	Result bool `json:"result"`
}

type Visit ¶

type Visit struct {
	// Unique identifier of the user's request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito bool `json:"incognito"`
	// IP address of the requesting browser or bot.
	Ip         string                 `json:"ip"`
	IpLocation *DeprecatedGeolocation `json:"ipLocation,omitempty"`
	// A customer-provided id that was sent with the request.
	LinkedId string `json:"linkedId,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format, when the request from the client agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible.
	Time *time.Time `json:"time"`
	// Page URL from which the request was sent.
	Url        string                    `json:"url"`
	Tag        *ModelMap                 `json:"tag"`
	Confidence *IdentificationConfidence `json:"confidence,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool                           `json:"visitorFound"`
	FirstSeenAt  *IdentificationSeenAt          `json:"firstSeenAt"`
	LastSeenAt   *IdentificationSeenAt          `json:"lastSeenAt"`
	Components   *map[string]RawDeviceAttribute `json:"components,omitempty"`
}

type VisitorsGetResponse ¶

type VisitorsGetResponse struct {
	VisitorId string  `json:"visitorId"`
	Visits    []Visit `json:"visits"`
	// ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results.
	LastTimestamp int64 `json:"lastTimestamp,omitempty"`
	// Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results.
	PaginationKey string `json:"paginationKey,omitempty"`
}

Pagination-related fields `lastTimestamp` and `paginationKey` are included if you use a pagination parameter like `limit` or `before` and there is more data available on the next page.

type Vpn ¶

type Vpn struct {
	// VPN or other anonymizing service has been used when sending the request.
	Result     bool           `json:"result"`
	Confidence *VpnConfidence `json:"confidence"`
	// Local timezone which is used in timezoneMismatch method.
	OriginTimezone string `json:"originTimezone"`
	// Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown).
	OriginCountry string      `json:"originCountry"`
	Methods       *VpnMethods `json:"methods"`
}

type VpnConfidence ¶

type VpnConfidence string

VpnConfidence : A confidence rating for the VPN detection result — \"low\", \"medium\", or \"high\". Depends on the combination of results returned from all VPN detection methods.

const (
	LOW    VpnConfidence = "low"
	MEDIUM VpnConfidence = "medium"
	HIGH   VpnConfidence = "high"
)

List of VPNConfidence

type VpnMethods ¶

type VpnMethods struct {
	// The browser timezone doesn't match the timezone inferred from the request IP address.
	TimezoneMismatch bool `json:"timezoneMismatch"`
	// Request IP address is owned and used by a public VPN service provider.
	PublicVPN bool `json:"publicVPN"`
	// This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices.
	AuxiliaryMobile bool `json:"auxiliaryMobile"`
	// The browser runs on a different operating system than the operating system inferred from the request network signature.
	OsMismatch bool `json:"osMismatch"`
	// Request IP address belongs to a relay service provider, indicating the use of relay services like [Apple Private relay](https://support.apple.com/en-us/102602) or [Cloudflare Warp](https://developers.cloudflare.com/warp-client/).   * Like VPNs, relay services anonymize the visitor's true IP address. * Unlike traditional VPNs, relay services don't let visitors spoof their location by choosing an exit node in a different country.  This field allows you to differentiate VPN users and relay service users in your fraud prevention logic.
	Relay bool `json:"relay"`
}

type Webhook ¶

type Webhook struct {
	// Unique identifier of the user's request.
	RequestId string `json:"requestId"`
	// Page URL from which the request was sent.
	Url string `json:"url"`
	// IP address of the requesting browser or bot.
	Ip  string    `json:"ip"`
	Tag *ModelMap `json:"tag,omitempty"`
	// Time expressed according to ISO 8601 in UTC format, when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible.
	Time *time.Time `json:"time"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp  int64                  `json:"timestamp"`
	IpLocation *DeprecatedGeolocation `json:"ipLocation,omitempty"`
	// A customer-provided id that was sent with the request.
	LinkedId string `json:"linkedId,omitempty"`
	// String of 20 characters that uniquely identifies the visitor's browser.
	VisitorId string `json:"visitorId,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound   bool                      `json:"visitorFound,omitempty"`
	Confidence     *IdentificationConfidence `json:"confidence,omitempty"`
	FirstSeenAt    *IdentificationSeenAt     `json:"firstSeenAt,omitempty"`
	LastSeenAt     *IdentificationSeenAt     `json:"lastSeenAt,omitempty"`
	BrowserDetails *BrowserDetails           `json:"browserDetails,omitempty"`
	// Flag if user used incognito session.
	Incognito           bool                           `json:"incognito,omitempty"`
	ClientReferrer      string                         `json:"clientReferrer,omitempty"`
	Components          *map[string]RawDeviceAttribute `json:"components,omitempty"`
	Bot                 *BotdBot                       `json:"bot,omitempty"`
	UserAgent           string                         `json:"userAgent,omitempty"`
	RootApps            *WebhookRootApps               `json:"rootApps,omitempty"`
	Emulator            *WebhookEmulator               `json:"emulator,omitempty"`
	IpInfo              *WebhookIpInfo                 `json:"ipInfo,omitempty"`
	IpBlocklist         *WebhookIpBlocklist            `json:"ipBlocklist,omitempty"`
	Tor                 *WebhookTor                    `json:"tor,omitempty"`
	Vpn                 *WebhookVpn                    `json:"vpn,omitempty"`
	Proxy               *WebhookProxy                  `json:"proxy,omitempty"`
	Tampering           *WebhookTampering              `json:"tampering,omitempty"`
	ClonedApp           *WebhookClonedApp              `json:"clonedApp,omitempty"`
	FactoryReset        *WebhookFactoryReset           `json:"factoryReset,omitempty"`
	Jailbroken          *WebhookJailbroken             `json:"jailbroken,omitempty"`
	Frida               *WebhookFrida                  `json:"frida,omitempty"`
	PrivacySettings     *WebhookPrivacySettings        `json:"privacySettings,omitempty"`
	VirtualMachine      *WebhookVirtualMachine         `json:"virtualMachine,omitempty"`
	RawDeviceAttributes *map[string]RawDeviceAttribute `json:"rawDeviceAttributes,omitempty"`
	HighActivity        *WebhookHighActivity           `json:"highActivity,omitempty"`
	LocationSpoofing    *WebhookLocationSpoofing       `json:"locationSpoofing,omitempty"`
	SuspectScore        *WebhookSuspectScore           `json:"suspectScore,omitempty"`
	RemoteControl       *WebhookRemoteControl          `json:"remoteControl,omitempty"`
	Velocity            *WebhookVelocity               `json:"velocity,omitempty"`
	DeveloperTools      *WebhookDeveloperTools         `json:"developerTools,omitempty"`
}

type WebhookClonedApp ¶

type WebhookClonedApp struct {
	// Android specific cloned application detection. There are 2 values:    * `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected).   * `false` - No signs of cloned application detected or the client is not Android.
	Result bool `json:"result,omitempty"`
}

type WebhookDeveloperTools ¶

type WebhookDeveloperTools struct {
	// `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookEmulator ¶

type WebhookEmulator struct {
	// Android specific emulator detection. There are 2 values:    * `true` - Emulated environment detected (e.g. launch inside of AVD).    * `false` - No signs of emulated environment detected or the client is not Android.
	Result bool `json:"result,omitempty"`
}

type WebhookFactoryReset ¶

type WebhookFactoryReset struct {
	// Indicates the time (in UTC) of the most recent factory reset that happened on the **mobile device**.  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 UTC). See [Factory Reset Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) to learn more about this Smart Signal.
	Time *time.Time `json:"time,omitempty"`
	// This field is just another representation of the value in the `time` field. The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time.
	Timestamp int64 `json:"timestamp,omitempty"`
}

type WebhookFrida ¶

type WebhookFrida struct {
	// [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values:   * `true` - Frida detected   * `false` - No signs of Frida or the client is not a mobile device.
	Result bool `json:"result,omitempty"`
}

type WebhookHighActivity ¶

type WebhookHighActivity struct {
	// Flag indicating if the request came from a high-activity visitor.
	Result bool `json:"result"`
	// Number of requests from the same visitor in the previous day.
	DailyRequests int64 `json:"dailyRequests,omitempty"`
}

type WebhookIpBlocklist ¶

type WebhookIpBlocklist struct {
	// `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise.
	Result  bool                `json:"result,omitempty"`
	Details *IpBlocklistDetails `json:"details,omitempty"`
}

type WebhookIpInfo ¶

type WebhookIpInfo struct {
	V4 *IpInfoV4 `json:"v4,omitempty"`
	V6 *IpInfoV6 `json:"v6,omitempty"`
}

Details about the request IP address. Has separate fields for v4 and v6 IP address versions.

type WebhookJailbroken ¶

type WebhookJailbroken struct {
	// iOS specific jailbreak detection. There are 2 values:    * `true` - Jailbreak detected.   * `false` - No signs of jailbreak or the client is not iOS.
	Result bool `json:"result,omitempty"`
}

type WebhookLocationSpoofing ¶

type WebhookLocationSpoofing struct {
	// Flag indicating whether the request came from a mobile device with location spoofing enabled.
	Result bool `json:"result,omitempty"`
}

type WebhookPrivacySettings ¶

type WebhookPrivacySettings struct {
	// `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
	Result bool `json:"result,omitempty"`
}

type WebhookProxy ¶

type WebhookProxy struct {
	// `true` if the request IP address is used by a public proxy provider, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookRemoteControl ¶

type WebhookRemoteControl struct {
	// `true` if the request came from a machine being remotely controlled (e.g. TeamViewer), `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookRootApps ¶

type WebhookRootApps struct {
	// Android specific root management apps detection. There are 2 values:    * `true` - Root Management Apps detected (e.g. Magisk).   * `false` - No Root Management Apps detected or the client isn't Android.
	Result bool `json:"result,omitempty"`
}

type WebhookSuspectScore ¶

type WebhookSuspectScore struct {
	// 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.  See more details here: https://dev.fingerprint.com/docs/suspect-score
	Result int32 `json:"result,omitempty"`
}

type WebhookTampering ¶

type WebhookTampering struct {
	// Flag indicating browser tampering was detected. This happens when either of these conditions is true:   * There are inconsistencies in the browser configuration that cross our internal tampering thresholds (indicated by `anomalyScore`).   * The browser signature resembles one of \"anti-detect\" browsers specifically designed to evade identification and fingerprinting, for example, Incognition (indicated by `antiDetectBrowser`).
	Result bool `json:"result,omitempty"`
	// Confidence score (`0.0 - 1.0`) for tampering detection:   * Values above `0.5` indicate that there was a tampering attempt   * Values below `0.5` indicate genuine browsers.
	AnomalyScore float64 `json:"anomalyScore,omitempty"`
	// Is `true` if the identified browser resembles one of \"anti-detect\" browsers, for example, Incognition. Anti-detect browsers try to evade identification by masking or manipulating their fingerprint to imitate legitimate browser configurations.
	AntiDetectBrowser bool `json:"antiDetectBrowser,omitempty"`
}

type WebhookTor ¶

type WebhookTor struct {
	// `true` if the request IP address is a known tor exit node, `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookVelocity ¶

type WebhookVelocity struct {
	DistinctIp                  *VelocityData `json:"distinctIp,omitempty"`
	DistinctLinkedId            *VelocityData `json:"distinctLinkedId,omitempty"`
	DistinctCountry             *VelocityData `json:"distinctCountry,omitempty"`
	Events                      *VelocityData `json:"events,omitempty"`
	IpEvents                    *VelocityData `json:"ipEvents,omitempty"`
	DistinctIpByLinkedId        *VelocityData `json:"distinctIpByLinkedId,omitempty"`
	DistinctVisitorIdByLinkedId *VelocityData `json:"distinctVisitorIdByLinkedId,omitempty"`
}

Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000.

type WebhookVirtualMachine ¶

type WebhookVirtualMachine struct {
	// `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
	Result bool `json:"result,omitempty"`
}

type WebhookVpn ¶

type WebhookVpn struct {
	// VPN or other anonymizing service has been used when sending the request.
	Result     bool           `json:"result,omitempty"`
	Confidence *VpnConfidence `json:"confidence,omitempty"`
	// Local timezone which is used in timezoneMismatch method.
	OriginTimezone string `json:"originTimezone,omitempty"`
	// Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown).
	OriginCountry string      `json:"originCountry,omitempty"`
	Methods       *VpnMethods `json:"methods,omitempty"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
sealed
webhook

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL