fraud

Documentation

Index

• type ASNProperties
• type BrowserProperties
• type Fingerprints
• type IPGeoProperties
• type Metadata
• type NetworkProperties
• type Properties
• type RuleAction
• type Verdict
• type VerdictAction

Types

type ASNProperties

type ASNProperties struct {
	// Asn: The Autonomous System Number of the user's network.
	Asn string `json:"asn,omitempty"`
	// Name: Public name associated with the ASN.
	Name string `json:"name,omitempty"`
	// Network: The CIDR block associated with the ASN.
	Network string `json:"network,omitempty"`
}

ASNProperties:

type BrowserProperties

type BrowserProperties struct {
	// UserAgent: The user agent of the user's browser.
	UserAgent string `json:"user_agent,omitempty"`
}

BrowserProperties:

type Fingerprints

type Fingerprints struct {
	// NetworkFingerprint: Combination of signals associated with a specific network commonly known as TLS
	// fingerprinting.
	NetworkFingerprint string `json:"network_fingerprint,omitempty"`
	// HardwareFingerprint: Combinations of signals to identify an operating system and architecture.
	HardwareFingerprint string `json:"hardware_fingerprint,omitempty"`
	// BrowserFingerprint: Combination of signals to identify a browser and its specific version.
	BrowserFingerprint string `json:"browser_fingerprint,omitempty"`
	// VisitorFingerprint: Cookie-less way of identifying a unique user.
	VisitorFingerprint string `json:"visitor_fingerprint,omitempty"`
	// VisitorID: The cookie stored on the user's device that uniquely identifies them.
	VisitorID string `json:"visitor_id,omitempty"`
	// BrowserID: Combination of VisitorID and NetworkFingerprint to create a clear identifier of a browser.
	BrowserID string `json:"browser_id,omitempty"`
}

Fingerprints:

type IPGeoProperties

type IPGeoProperties struct {
	// City: The city where the IP is located.
	City string `json:"city,omitempty"`
	// Region: The region where the IP is located.
	Region string `json:"region,omitempty"`
	// Country: The country where the IP is located.
	Country string `json:"country,omitempty"`
}

IPGeoProperties:

type Metadata

type Metadata struct {
	// ExternalID: An external ID, such as a user ID, that you wish to associate with the telemetry ID.
	ExternalID string `json:"external_id,omitempty"`
	// OrganizationID: The organization ID you wish to associate with the telemetry ID.
	OrganizationID string `json:"organization_id,omitempty"`
	// UserAction: The user action, such as 'login', that you wish to associate with the telemetry ID.
	UserAction string `json:"user_action,omitempty"`
}

Metadata:

type NetworkProperties

type NetworkProperties struct {
	// IPAddress: The IP address of the user.
	IPAddress string `json:"ip_address,omitempty"`
	// Asn: Information about the network's ASN (Autonomous System Number).
	Asn ASNProperties `json:"asn,omitempty"`
	// IPGeolocation: Information about the geolocation of the user's IP address.
	IPGeolocation IPGeoProperties `json:"ip_geolocation,omitempty"`
	// IsProxy: Whether the user is using a proxy.
	IsProxy bool `json:"is_proxy,omitempty"`
	// IsVpn: Whether the user is using a VPN.
	IsVpn bool `json:"is_vpn,omitempty"`
}

NetworkProperties:

type Properties

type Properties struct {
	NetworkProperties NetworkProperties `json:"network_properties,omitempty"`
	BrowserProperties BrowserProperties `json:"browser_properties,omitempty"`
}

Properties:

type RuleAction

type RuleAction string

const (
	RuleActionALLOW     RuleAction = "ALLOW"
	RuleActionCHALLENGE RuleAction = "CHALLENGE"
	RuleActionBLOCK     RuleAction = "BLOCK"
	RuleActionNONE      RuleAction = "NONE"
)

type Verdict

type Verdict struct {
	// Action: The suggested action based on the fingerprint review. The available actions are:
	//   * `ALLOW` - This is a known valid device grouping or device profile that is part of the default ALLOW
	// listed set of known devices by Stytch. This grouping is made up of verified device profiles that match
	// the characteristics of known/authentic traffic origins
	//   * `BLOCK` - This is a known bad or malicious device profile that is undesirable and should be blocked
	// from completing the privileged action in question
	//   * `CHALLENGE` - This is an unknown or potentially malicious device that should be put through
	// increased friction such as 2FA or other forms of extended user verification before allowing the
	// privileged action to proceed
	//
	Action VerdictAction `json:"action,omitempty"`
	// Reasons: A set of contextual clues to inform why a `CHALLENGE` or `BLOCK` action was suggested. For a
	// list of possible Reasons, please [contact support](mailto:support@stytch.com).
	Reasons []string `json:"reasons,omitempty"`
	// DetectedDeviceType: The operating system and architecture that took the fingerprint.
	DetectedDeviceType string `json:"detected_device_type,omitempty"`
	// IsAuthenticDevice: The assessment of whether this is an authentic device. It will be false if hardware
	// or browser deception is detected.
	IsAuthenticDevice bool `json:"is_authentic_device,omitempty"`
}

Verdict:

type VerdictAction

type VerdictAction string

const (
	VerdictActionALLOW     VerdictAction = "ALLOW"
	VerdictActionCHALLENGE VerdictAction = "CHALLENGE"
	VerdictActionBLOCK     VerdictAction = "BLOCK"
)