Stytch · Schema

api_fraud_v1_fraud_rules_SetResponse

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
request_id	string	Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug
action	object	The action that will be returned for the specified identifier.
status_code	integer	The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server
visitor_id	string	The visitor ID that a rule was set for.
browser_id	string	The browser ID that a rule was set for.
visitor_fingerprint	string	The visitor fingerprint that a rule was set for.
browser_fingerprint	string	The browser fingerprint that a rule was set for.
hardware_fingerprint	string	The hardware fingerprint that a rule was set for.
network_fingerprint	string	The network fingerprint that a rule was set for.
expires_at	string	The timestamp when the rule expires. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
cidr_block	string	The CIDR block that a rule was set for. If an end user's IP address is within this CIDR block, this rule will be applied.
country_code	string	The country code that a rule was set for.
asn	string	The ASN that a rule was set for.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_fraud_v1_fraud_rules_SetResponse",
  "title": "api_fraud_v1_fraud_rules_SetResponse",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue."
    },
    "action": {
      "$ref": "#/components/schemas/api_fraud_v1_RuleAction",
      "description": "The action that will be returned for the specified identifier."
    },
    "status_code": {
      "type": "integer",
      "format": "int32",
      "description": "The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors."
    },
    "visitor_id": {
      "type": "string",
      "description": "The visitor ID that a rule was set for."
    },
    "browser_id": {
      "type": "string",
      "description": "The browser ID that a rule was set for."
    },
    "visitor_fingerprint": {
      "type": "string",
      "description": "The visitor fingerprint that a rule was set for."
    },
    "browser_fingerprint": {
      "type": "string",
      "description": "The browser fingerprint that a rule was set for."
    },
    "hardware_fingerprint": {
      "type": "string",
      "description": "The hardware fingerprint that a rule was set for."
    },
    "network_fingerprint": {
      "type": "string",
      "description": "The network fingerprint that a rule was set for."
    },
    "expires_at": {
      "type": "string",
      "description": "The timestamp when the rule expires. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`."
    },
    "cidr_block": {
      "type": "string",
      "description": "The CIDR block that a rule was set for. If an end user's IP address is within this CIDR block, this rule will be applied."
    },
    "country_code": {
      "type": "string",
      "description": "The country code that a rule was set for."
    },
    "asn": {
      "type": "string",
      "description": "The ASN that a rule was set for."
    }
  },
  "required": [
    "request_id",
    "action",
    "status_code"
  ]
}