sdk

package

v6.1.0 Latest Latest Go to latest Published: Jul 30, 2024 License: MIT Imports: 9 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fingerprintjs/fingerprint-pro-server-api-go-sdk

Links

Open Source Insights

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 (e ApiError) Body() []byte
- func (e ApiError) Error() string
- func (e ApiError) Model() any
type Asn
type BasicAuth
type BotdDetectionResult
type BotdResult
type BrowserDetails
type ClonedAppResult
type Common403ErrorResponse
type Confidence
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 DataCenter
type DeprecatedIpLocation
type DeprecatedIpLocationCity
type DeveloperToolsResult
type EmulatorResult
type ErrorCommon403Response
type ErrorCommon429Response
type ErrorCommon429ResponseError
type ErrorEvent403Response
type ErrorEvent403ResponseError
type ErrorEvent404Response
type ErrorEvent404ResponseError
type ErrorVisits403
type ErrorVisitsDelete400Response
type ErrorVisitsDelete400ResponseError
type ErrorVisitsDelete404Response
type ErrorVisitsDelete404ResponseError
type EventResponse
type FactoryResetResult
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) (EventResponse, *http.Response, error)
- func (f *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, opts *FingerprintApiGetVisitsOpts) (Response, *http.Response, error)
type FingerprintApiServiceInterface
type FridaResult
type HighActivityResult
type IdentificationError
type IncognitoResult
type IpBlockListResult
type IpBlockListResultDetails
type IpInfoResult
type IpInfoResultV4
type IpInfoResultV6
type IpLocation
type IpLocationCity
type JailbrokenResult
type Location
type LocationSpoofingResult
type Model
type ModelError
type ModelMap
type Object
type PrivacySettingsResult
type ProductError
type ProductsResponse
type ProductsResponseBotd
type ProductsResponseIdentification
type ProductsResponseIdentificationData
type ProxyResult
type Region
type RemoteControlResult
type Response
type ResponseVisits
type RootAppsResult
type SeenAt
type SignalResponseClonedApp
type SignalResponseDeveloperTools
type SignalResponseEmulator
type SignalResponseFactoryReset
type SignalResponseFrida
type SignalResponseHighActivity
type SignalResponseIncognito
type SignalResponseIpBlocklist
type SignalResponseIpInfo
type SignalResponseJailbroken
type SignalResponseLocationSpoofing
type SignalResponsePrivacySettings
type SignalResponseProxy
type SignalResponseRawDeviceAttributes
type SignalResponseRemoteControl
type SignalResponseRootApps
type SignalResponseSuspectScore
type SignalResponseTampering
type SignalResponseTor
type SignalResponseVelocity
type SignalResponseVirtualMachine
type SignalResponseVpn
type Subdivision
type SuspectScoreResult
type TamperingResult
type TooManyRequestsError
- func (e *TooManyRequestsError) Body() []byte
- func (e *TooManyRequestsError) Code() string
- func (e *TooManyRequestsError) Error() string
- func (e *TooManyRequestsError) Model() any
- func (e *TooManyRequestsError) RetryAfter() int64
type TooManyRequestsResponse
type TorResult
type VelocityIntervalResult
type VelocityIntervals
type VelocityResult
type VirtualMachineResult
type Visit
type VpnResult
type VpnResultMethods
type WebhookVisit

Constants ¶

View Source

const IntegrationInfo = "fingerprint-pro-server-go-sdk/6.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 (ApiError) Body ¶

func (e ApiError) Body() []byte

Body returns the raw bytes of the response

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

Model returns the unpacked model of the error

type Asn ¶

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

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 BotdDetectionResult ¶

type BotdDetectionResult struct {
	// 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
	Result string `json:"result"`
	Type_  string `json:"type,omitempty"`
}

Stores bot detection result

type BotdResult ¶

type BotdResult struct {
	// 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"`
	// Page URL from which identification request was sent.
	Url       string               `json:"url"`
	UserAgent string               `json:"userAgent"`
	RequestId string               `json:"requestId"`
	LinkedId  string               `json:"linkedId,omitempty"`
	Bot       *BotdDetectionResult `json:"bot"`
}

Contains all the information from Bot Detection product

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"`
	BotProbability      int32  `json:"botProbability,omitempty"`
}

type ClonedAppResult ¶

type ClonedAppResult 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 Common403ErrorResponse ¶

type Common403ErrorResponse struct {
	// Error code:  * `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
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Confidence ¶

type Confidence struct {
	// The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.
	Score float32 `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"`
}

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 DataCenter ¶

type DataCenter struct {
	Result bool   `json:"result"`
	Name   string `json:"name,omitempty"`
}

type DeprecatedIpLocation ¶

type DeprecatedIpLocation 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           *DeprecatedIpLocationCity `json:"city,omitempty"`
	Country        *Location                 `json:"country,omitempty"`
	Continent      *Location                 `json:"continent,omitempty"`
	Subdivisions   []Subdivision             `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 DeprecatedIpLocationCity ¶

type DeprecatedIpLocationCity struct {
	Name string `json:"name,omitempty"`
}

type DeveloperToolsResult ¶ added in v6.1.0

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

type EmulatorResult ¶

type EmulatorResult 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 ErrorCommon403Response ¶

type ErrorCommon403Response struct {
	Error_ *Common403ErrorResponse `json:"error,omitempty"`
}

type ErrorCommon429Response ¶

type ErrorCommon429Response struct {
	Error_ *ErrorCommon429ResponseError `json:"error,omitempty"`
}

type ErrorCommon429ResponseError ¶

type ErrorCommon429ResponseError struct {
	// Error code: * `TooManyRequests` - The request is throttled.
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorEvent403Response ¶

type ErrorEvent403Response struct {
	Error_ *ErrorEvent403ResponseError `json:"error,omitempty"`
}

type ErrorEvent403ResponseError ¶

type ErrorEvent403ResponseError struct {
	// Error code:  * `TokenRequired` - `Auth-API-Key` header is missing or empty  * `TokenNotFound` - subscription not found for specified secret key  * `SubscriptionNotActive` - subscription is not active  * `WrongRegion` - server and subscription region differ
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorEvent404Response ¶

type ErrorEvent404Response struct {
	Error_ *ErrorEvent404ResponseError `json:"error,omitempty"`
}

type ErrorEvent404ResponseError ¶

type ErrorEvent404ResponseError struct {
	// Error code:  * `RequestNotFound` - The specified request ID was not found. It never existed, expired, or it has been deleted.
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorVisits403 ¶

type ErrorVisits403 struct {
	// Error text.
	Error_ string `json:"error"`
}

type ErrorVisitsDelete400Response ¶

type ErrorVisitsDelete400Response struct {
	Error_ *ErrorVisitsDelete400ResponseError `json:"error,omitempty"`
}

type ErrorVisitsDelete400ResponseError ¶

type ErrorVisitsDelete400ResponseError struct {
	// Error code: * `RequestCannotBeParsed` - The visitor ID parameter is missing or in the wrong format.
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ErrorVisitsDelete404Response ¶

type ErrorVisitsDelete404Response struct {
	Error_ *ErrorVisitsDelete404ResponseError `json:"error,omitempty"`
}

type ErrorVisitsDelete404ResponseError ¶

type ErrorVisitsDelete404ResponseError struct {
	// Error code: * `VisitorNotFound` - The specified visitor ID was not found. It never existed or it may have already been deleted.
	Code    string `json:"code"`
	Message string `json:"message"`
}

type EventResponse ¶

type EventResponse struct {
	Products *ProductsResponse `json:"products"`
	Error_   *ProductError     `json:"error,omitempty"`
}

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

type FactoryResetResult ¶

type FactoryResetResult struct {
	// Time in UTC when the most recent factory reset of the Android or iOS device was done.  If there is no sign of factory reset or the client is not a mobile device, the field will contain the epoch time (1 January 1970) in UTC.
	Time *time.Time `json:"time"`
	// Same value as it's in the `time` field but represented in timestamp format.
	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) (EventResponse, *http.Response, error)

func (*FingerprintApiService) GetVisits ¶

func (f *FingerprintApiService) GetVisits(ctx context.Context, visitorId string, opts *FingerprintApiGetVisitsOpts) (Response, *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. All delete requests are queued:   * Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours. * Data from older (11 days or more) identification events  will be deleted after 90 days.  If you are interested in using this API, 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/docs/js-agent#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/docs/js-agent#requestid) of each identification request.
	       @return EventResponse
	*/
	GetEvent(ctx context.Context, requestId string) (EventResponse, *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/docs/js-agent#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/docs/js-agent#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/docs/js-agent#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 Response
	*/
	GetVisits(ctx context.Context, visitorId string, opts *FingerprintApiGetVisitsOpts) (Response, *http.Response, error)
}

type FridaResult ¶

type FridaResult 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 HighActivityResult ¶

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

type IdentificationError ¶

type IdentificationError struct {
	// Error code:  * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error
	Code    string `json:"code"`
	Message string `json:"message"`
}

type IncognitoResult ¶

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

type IpBlockListResult ¶

type IpBlockListResult 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 *IpBlockListResultDetails `json:"details"`
}

type IpBlockListResultDetails ¶

type IpBlockListResultDetails 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 IpInfoResult ¶

type IpInfoResult struct {
	V4 *IpInfoResultV4 `json:"v4,omitempty"`
	V6 *IpInfoResultV6 `json:"v6,omitempty"`
}

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

type IpInfoResultV4 ¶

type IpInfoResultV4 struct {
	Address     string      `json:"address"`
	Geolocation *IpLocation `json:"geolocation"`
	Asn         *Asn        `json:"asn,omitempty"`
	Datacenter  *DataCenter `json:"datacenter,omitempty"`
}

type IpInfoResultV6 ¶

type IpInfoResultV6 struct {
	Address     string      `json:"address"`
	Geolocation *IpLocation `json:"geolocation"`
	Asn         *Asn        `json:"asn,omitempty"`
	Datacenter  *DataCenter `json:"datacenter,omitempty"`
}

type IpLocation ¶

type IpLocation 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           *IpLocationCity `json:"city,omitempty"`
	Country        *Location       `json:"country,omitempty"`
	Continent      *Location       `json:"continent,omitempty"`
	Subdivisions   []Subdivision   `json:"subdivisions,omitempty"`
}

type IpLocationCity ¶

type IpLocationCity struct {
	Name string `json:"name,omitempty"`
}

type JailbrokenResult ¶

type JailbrokenResult 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 Location ¶

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

type LocationSpoofingResult ¶

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

type Model ¶

type Model struct{}

type ModelError ¶

type ModelError struct {
	Name    string `json:"name"`
	Message string `json:"message"`
}

type ModelMap ¶

type ModelMap map[string]string

type Object ¶

type Object map[string]any

type PrivacySettingsResult ¶

type PrivacySettingsResult 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 ProductError ¶

type ProductError struct {
	// Error code:  * `TooManyRequests` - the limit on secret API key requests per second has been exceeded  * `Failed` - internal server error
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ProductsResponse ¶

type ProductsResponse struct {
	Identification      *ProductsResponseIdentification    `json:"identification,omitempty"`
	Botd                *ProductsResponseBotd              `json:"botd,omitempty"`
	IpInfo              *SignalResponseIpInfo              `json:"ipInfo,omitempty"`
	Incognito           *SignalResponseIncognito           `json:"incognito,omitempty"`
	RootApps            *SignalResponseRootApps            `json:"rootApps,omitempty"`
	Emulator            *SignalResponseEmulator            `json:"emulator,omitempty"`
	ClonedApp           *SignalResponseClonedApp           `json:"clonedApp,omitempty"`
	FactoryReset        *SignalResponseFactoryReset        `json:"factoryReset,omitempty"`
	Jailbroken          *SignalResponseJailbroken          `json:"jailbroken,omitempty"`
	Frida               *SignalResponseFrida               `json:"frida,omitempty"`
	IpBlocklist         *SignalResponseIpBlocklist         `json:"ipBlocklist,omitempty"`
	Tor                 *SignalResponseTor                 `json:"tor,omitempty"`
	PrivacySettings     *SignalResponsePrivacySettings     `json:"privacySettings,omitempty"`
	VirtualMachine      *SignalResponseVirtualMachine      `json:"virtualMachine,omitempty"`
	Vpn                 *SignalResponseVpn                 `json:"vpn,omitempty"`
	Proxy               *SignalResponseProxy               `json:"proxy,omitempty"`
	Tampering           *SignalResponseTampering           `json:"tampering,omitempty"`
	HighActivity        *SignalResponseHighActivity        `json:"highActivity,omitempty"`
	LocationSpoofing    *SignalResponseLocationSpoofing    `json:"locationSpoofing,omitempty"`
	SuspectScore        *SignalResponseSuspectScore        `json:"suspectScore,omitempty"`
	RawDeviceAttributes *SignalResponseRawDeviceAttributes `json:"rawDeviceAttributes,omitempty"`
	RemoteControl       *SignalResponseRemoteControl       `json:"remoteControl,omitempty"`
	Velocity            *SignalResponseVelocity            `json:"velocity,omitempty"`
	DeveloperTools      *SignalResponseDeveloperTools      `json:"developerTools,omitempty"`
}

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

type ProductsResponseBotd ¶

type ProductsResponseBotd struct {
	Data   *BotdResult   `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type ProductsResponseIdentification ¶

type ProductsResponseIdentification struct {
	Data   *ProductsResponseIdentificationData `json:"data,omitempty"`
	Error_ *IdentificationError                `json:"error,omitempty"`
}

type ProductsResponseIdentificationData ¶

type ProductsResponseIdentificationData struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool                  `json:"incognito"`
	Ip         string                `json:"ip"`
	IpLocation *DeprecatedIpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which the identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
	// String of 20 characters that uniquely identifies the visitor's browser.
	VisitorId string `json:"visitorId"`
}

type ProxyResult ¶

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

type Region ¶

type Region string

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

type RemoteControlResult ¶ added in v6.1.0

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

type Response ¶

type Response struct {
	VisitorId string           `json:"visitorId"`
	Visits    []ResponseVisits `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"`
}

Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` parameter provided and there is more data to show

type ResponseVisits ¶

type ResponseVisits struct {
	// Unique identifier of the user's identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool                  `json:"incognito"`
	Ip         string                `json:"ip"`
	IpLocation *DeprecatedIpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which the identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

type RootAppsResult ¶

type RootAppsResult 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 SeenAt ¶

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

type SignalResponseClonedApp ¶

type SignalResponseClonedApp struct {
	Data   *ClonedAppResult `json:"data,omitempty"`
	Error_ *ProductError    `json:"error,omitempty"`
}

type SignalResponseDeveloperTools ¶ added in v6.1.0

type SignalResponseDeveloperTools struct {
	Data   *DeveloperToolsResult `json:"data,omitempty"`
	Error_ *ProductError         `json:"error,omitempty"`
}

type SignalResponseEmulator ¶

type SignalResponseEmulator struct {
	Data   *EmulatorResult `json:"data,omitempty"`
	Error_ *ProductError   `json:"error,omitempty"`
}

type SignalResponseFactoryReset ¶

type SignalResponseFactoryReset struct {
	Data   *FactoryResetResult `json:"data,omitempty"`
	Error_ *ProductError       `json:"error,omitempty"`
}

type SignalResponseFrida ¶

type SignalResponseFrida struct {
	Data   *FridaResult  `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type SignalResponseHighActivity ¶

type SignalResponseHighActivity struct {
	Data   *HighActivityResult `json:"data,omitempty"`
	Error_ *ProductError       `json:"error,omitempty"`
}

type SignalResponseIncognito ¶

type SignalResponseIncognito struct {
	Data   *IncognitoResult     `json:"data,omitempty"`
	Error_ *IdentificationError `json:"error,omitempty"`
}

type SignalResponseIpBlocklist ¶

type SignalResponseIpBlocklist struct {
	Data   *IpBlockListResult `json:"data,omitempty"`
	Error_ *ProductError      `json:"error,omitempty"`
}

type SignalResponseIpInfo ¶

type SignalResponseIpInfo struct {
	Data   *IpInfoResult `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type SignalResponseJailbroken ¶

type SignalResponseJailbroken struct {
	Data   *JailbrokenResult `json:"data,omitempty"`
	Error_ *ProductError     `json:"error,omitempty"`
}

type SignalResponseLocationSpoofing ¶

type SignalResponseLocationSpoofing struct {
	Data   *LocationSpoofingResult `json:"data,omitempty"`
	Error_ *ProductError           `json:"error,omitempty"`
}

type SignalResponsePrivacySettings ¶

type SignalResponsePrivacySettings struct {
	Data   *PrivacySettingsResult `json:"data,omitempty"`
	Error_ *ProductError          `json:"error,omitempty"`
}

type SignalResponseProxy ¶

type SignalResponseProxy struct {
	Data   *ProxyResult  `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type SignalResponseRawDeviceAttributes ¶

type SignalResponseRawDeviceAttributes struct {
	Data   *map[string]interface{} `json:"data,omitempty"`
	Error_ *IdentificationError    `json:"error,omitempty"`
}

type SignalResponseRemoteControl ¶ added in v6.1.0

type SignalResponseRemoteControl struct {
	Data   *RemoteControlResult `json:"data,omitempty"`
	Error_ *ProductError        `json:"error,omitempty"`
}

type SignalResponseRootApps ¶

type SignalResponseRootApps struct {
	Data   *RootAppsResult `json:"data,omitempty"`
	Error_ *ProductError   `json:"error,omitempty"`
}

type SignalResponseSuspectScore ¶

type SignalResponseSuspectScore struct {
	Data   *SuspectScoreResult `json:"data,omitempty"`
	Error_ *ProductError       `json:"error,omitempty"`
}

type SignalResponseTampering ¶

type SignalResponseTampering struct {
	Data   *TamperingResult     `json:"data,omitempty"`
	Error_ *IdentificationError `json:"error,omitempty"`
}

type SignalResponseTor ¶

type SignalResponseTor struct {
	Data   *TorResult    `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type SignalResponseVelocity ¶ added in v6.1.0

type SignalResponseVelocity struct {
	Data   *VelocityResult `json:"data,omitempty"`
	Error_ *ProductError   `json:"error,omitempty"`
}

type SignalResponseVirtualMachine ¶

type SignalResponseVirtualMachine struct {
	Data   *VirtualMachineResult `json:"data,omitempty"`
	Error_ *ProductError         `json:"error,omitempty"`
}

type SignalResponseVpn ¶

type SignalResponseVpn struct {
	Data   *VpnResult    `json:"data,omitempty"`
	Error_ *ProductError `json:"error,omitempty"`
}

type Subdivision ¶

type Subdivision struct {
	IsoCode string `json:"isoCode,omitempty"`
	Name    string `json:"name,omitempty"`
}

type SuspectScoreResult ¶

type SuspectScoreResult 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 TamperingResult ¶

type TamperingResult struct {
	// Flag indicating whether browser tampering was detected according to our internal thresholds.
	Result bool `json:"result"`
	// Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers.
	AnomalyScore float64 `json:"anomalyScore"`
}

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() string

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 TooManyRequestsResponse ¶

type TooManyRequestsResponse struct {
	// Error text.
	Error_ string `json:"error"`
}

type TorResult ¶

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

type VelocityIntervalResult ¶ added in v6.1.0

type VelocityIntervalResult struct {
	Var5m int32 `json:"5m"`
	Var1h int32 `json:"1h"`
	// The `24h` interval of `distinctIp`, `distinctLinkedId`, and `distinctCountry` 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 VelocityIntervals ¶ added in v6.1.0

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

type VelocityResult ¶ added in v6.1.0

type VelocityResult struct {
	DistinctIp       *VelocityIntervals `json:"distinctIp"`
	DistinctLinkedId *VelocityIntervals `json:"distinctLinkedId"`
	DistinctCountry  *VelocityIntervals `json:"distinctCountry"`
	Events           *VelocityIntervals `json:"events"`
}

Sums key data points for a specific `visitorId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of identification events attributed to the visitor ID - Number of distinct IP addresses associated to the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of distinct `linkedId`s associated with the visitor ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, and `distinctCountry` 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 VirtualMachineResult ¶

type VirtualMachineResult 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 identification request.
	RequestId      string          `json:"requestId"`
	BrowserDetails *BrowserDetails `json:"browserDetails"`
	// Flag if user used incognito session.
	Incognito  bool                  `json:"incognito"`
	Ip         string                `json:"ip"`
	IpLocation *DeprecatedIpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which the identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

type VpnResult ¶

type VpnResult struct {
	// VPN or other anonymizing service has been used when sending the request.
	Result bool `json:"result"`
	// 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,omitempty"`
	Methods       *VpnResultMethods `json:"methods"`
}

type VpnResultMethods ¶

type VpnResultMethods 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"`
}

type WebhookVisit ¶

type WebhookVisit struct {
	VisitorId      string               `json:"visitorId"`
	ClientReferrer string               `json:"clientReferrer,omitempty"`
	UserAgent      string               `json:"userAgent,omitempty"`
	Bot            *BotdDetectionResult `json:"bot,omitempty"`
	IpInfo         *IpInfoResult        `json:"ipInfo,omitempty"`
	// Flag if user used incognito session.
	Incognito           bool                    `json:"incognito"`
	RootApps            *RootAppsResult         `json:"rootApps,omitempty"`
	Emulator            *EmulatorResult         `json:"emulator,omitempty"`
	ClonedApp           *ClonedAppResult        `json:"clonedApp,omitempty"`
	FactoryReset        *FactoryResetResult     `json:"factoryReset,omitempty"`
	Jailbroken          *JailbrokenResult       `json:"jailbroken,omitempty"`
	Frida               *FridaResult            `json:"frida,omitempty"`
	IpBlocklist         *IpBlockListResult      `json:"ipBlocklist,omitempty"`
	Tor                 *TorResult              `json:"tor,omitempty"`
	PrivacySettings     *PrivacySettingsResult  `json:"privacySettings,omitempty"`
	VirtualMachine      *VirtualMachineResult   `json:"virtualMachine,omitempty"`
	Vpn                 *VpnResult              `json:"vpn,omitempty"`
	Proxy               *ProxyResult            `json:"proxy,omitempty"`
	Tampering           *TamperingResult        `json:"tampering,omitempty"`
	RawDeviceAttributes *map[string]interface{} `json:"rawDeviceAttributes,omitempty"`
	HighActivity        *HighActivityResult     `json:"highActivity,omitempty"`
	LocationSpoofing    *LocationSpoofingResult `json:"locationSpoofing,omitempty"`
	SuspectScore        *SuspectScoreResult     `json:"suspectScore,omitempty"`
	RemoteControl       *RemoteControlResult    `json:"remoteControl,omitempty"`
	Velocity            *VelocityResult         `json:"velocity,omitempty"`
	DeveloperTools      *DeveloperToolsResult   `json:"developerTools,omitempty"`
	// Unique identifier of the user's identification request.
	RequestId      string                `json:"requestId"`
	BrowserDetails *BrowserDetails       `json:"browserDetails"`
	Ip             string                `json:"ip"`
	IpLocation     *DeprecatedIpLocation `json:"ipLocation,omitempty"`
	// Timestamp of the event with millisecond precision in Unix time.
	Timestamp int64 `json:"timestamp"`
	// Time expressed according to ISO 8601 in UTC format.
	Time *time.Time `json:"time"`
	// Page URL from which the identification request was sent.
	Url string `json:"url"`
	// A customer-provided value or an object that was sent with identification request.
	Tag ModelMap `json:"tag"`
	// A customer-provided id that was sent with identification request.
	LinkedId   string      `json:"linkedId,omitempty"`
	Confidence *Confidence `json:"confidence,omitempty"`
	// Attribute represents if a visitor had been identified before.
	VisitorFound bool    `json:"visitorFound"`
	FirstSeenAt  *SeenAt `json:"firstSeenAt"`
	LastSeenAt   *SeenAt `json:"lastSeenAt"`
}

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