---
updatedAt: 2026-09-01T20:32:46.000Z
agentTools:
  projectIndex: https://developer.openpath.io/llms.txt
---

# Void

Voids a previously authorized but not yet captured payment transaction. Validates the authenticated user
and returns the transaction details for voiding the authorization. Voiding is typically used to cancel a
transaction before funds are captured or settled.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenPath API",
    "version": "v5"
  },
  "servers": [
    {
      "url": "https://api.openpath.io/v5"
    }
  ],
  "paths": {
    "/Transaction/void": {
      "post": {
        "tags": [
          "Transaction"
        ],
        "summary": "Void",
        "description": "Voids a previously authorized but not yet captured payment transaction. Validates the authenticated user\r\nand returns the transaction details for voiding the authorization. Voiding is typically used to cancel a\r\ntransaction before funds are captured or settled.",
        "requestBody": {
          "description": "A Data.Dto.Transaction.Request.TransactionActionDto containing the token and transaction details to be voided.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Data.Dto.Transaction.Request.TransactionActionDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/Data.Dto.Transaction.Request.TransactionActionDto"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/Data.Dto.Transaction.Request.TransactionActionDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully processed the void request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.Response.TransactionResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad request due to invalid input data.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.StatusErrorDto"
                }
              }
            }
          },
          "401": {
            "description": "Returned when the user is not authenticated or cannot be found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.StatusErrorDto"
                }
              }
            }
          },
          "415": {
            "description": "Returned when the data packet doesn't matches the supported media type.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.StatusErrorDto"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Data.Dto.Transaction.Request.TransactionActionDto": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "nullable": true
          },
          "total": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "example": {
          "transactionId": "12088864608",
          "total": 99.31
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.Enumerator.SplitSettlementCategoryEnumerator": {
        "enum": [
          "merchant",
          "platform_fee",
          "tax",
          "shipping",
          "tip",
          "other"
        ],
        "type": "string"
      },
      "OpenPath.V5.Data.Dto.Transaction.SplitSettlementDto": {
        "required": [
          "splits",
          "total"
        ],
        "type": "object",
        "properties": {
          "total": {
            "minimum": 0,
            "exclusiveMinimum": true,
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "reference": {
            "minLength": 1,
            "type": "string",
            "nullable": true
          },
          "description": {
            "minLength": 1,
            "type": "string",
            "nullable": true
          },
          "splits": {
            "minItems": 2,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.SplitSettlementEntryDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "total": 99.31,
          "reference": "ORDER-10001",
          "description": "Marketplace order settlement",
          "splits": [
            {
              "merchant_account_id": "seller_acct_123",
              "amount": 89.31,
              "category": "merchant",
              "reference": "ORDER-10001-seller",
              "description": "Seller proceeds"
            },
            {
              "merchant_account_id": "platform_acct_001",
              "amount": 10,
              "category": "platform_fee",
              "reference": "ORDER-10001-platform-fee",
              "description": "Platform commission"
            }
          ]
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.SplitSettlementEntryDto": {
        "required": [
          "amount",
          "merchant_account_id"
        ],
        "type": "object",
        "properties": {
          "merchant_account_id": {
            "minLength": 1,
            "type": "string",
            "nullable": true
          },
          "amount": {
            "minimum": 0,
            "exclusiveMinimum": true,
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "category": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.Enumerator.SplitSettlementCategoryEnumerator"
          },
          "reference": {
            "minLength": 1,
            "type": "string",
            "nullable": true
          },
          "description": {
            "minLength": 1,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "merchant_account_id": "seller_acct_123",
          "amount": 89.31,
          "category": "merchant",
          "reference": "ORDER-10001-seller",
          "description": "Seller proceeds"
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.AddressDto": {
        "type": "object",
        "properties": {
          "address_line1": {
            "maxLength": 200,
            "type": "string",
            "nullable": true
          },
          "address_line2": {
            "maxLength": 200,
            "type": "string",
            "nullable": true
          },
          "city": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "region": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "postal_code": {
            "maxLength": 20,
            "type": "string",
            "nullable": true
          },
          "country": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "address_line1": "475 Market Street",
          "address_line2": "Suite 2200",
          "city": "San Francisco",
          "region": "CA",
          "postal_code": "94105",
          "country": "US"
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.CreditCardDto": {
        "type": "object",
        "properties": {
          "name_on_card": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "number": {
            "type": "string",
            "nullable": true
          },
          "cvv": {
            "type": "string",
            "nullable": true
          },
          "expiration_month": {
            "type": "integer",
            "format": "int32"
          },
          "expiration_year": {
            "type": "integer",
            "format": "int32"
          },
          "billing_address": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.AddressDto"
          }
        },
        "additionalProperties": false,
        "example": {
          "name_on_card": "Avery Johnson",
          "number": "4111111111111111",
          "cvv": "123",
          "expiration_month": 12,
          "expiration_year": 2030,
          "billing_address": {
            "address_line1": "475 Market Street",
            "address_line2": "Suite 2200",
            "city": "San Francisco",
            "region": "CA",
            "postal_code": "94105",
            "country": "US"
          }
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.CustomerDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "first_name": {
            "type": "string",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "nullable": true
          },
          "email_address": {
            "type": "string",
            "format": "email",
            "nullable": true
          },
          "phone_number": {
            "pattern": "^\\+?[1-9]\\d{1,14}$",
            "type": "string",
            "format": "tel",
            "nullable": true
          },
          "reference": {
            "type": "string",
            "nullable": true
          },
          "shipping_address": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.AddressDto"
          }
        },
        "additionalProperties": false,
        "example": {
          "first_name": "Avery",
          "last_name": "Johnson",
          "email_address": "avery.johnson@example.com",
          "phone_number": "+14155550199",
          "shipping_address": {
            "address_line1": "475 Market Street",
            "address_line2": "Suite 2200",
            "city": "San Francisco",
            "region": "CA",
            "postal_code": "94105",
            "country": "US"
          }
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.DeclineRecaptureDto": {
        "type": "object",
        "properties": {
          "decline_code": {
            "maxLength": 50,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "decline_description": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "decline_source": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "decline_avs_code": {
            "maxLength": 10,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "decline_cvv_code": {
            "maxLength": 10,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "decline_cavv_code": {
            "maxLength": 10,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "network_schema_id": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "network_schema": {
            "maxLength": 50,
            "minLength": 0,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "decline_code": "05",
          "decline_description": "Do not honor",
          "decline_source": "issuer",
          "decline_avs_code": "N",
          "decline_cvv_code": "M",
          "decline_cavv_code": "2",
          "network_schema_id": "123456789",
          "network_schema": "VISA"
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.Enumerator.MetadataValueTypeEnumerator": {
        "enum": [
          "String",
          "Number",
          "Decimal"
        ],
        "type": "string"
      },
      "OpenPath.V5.Data.Dto.Transaction.LineItemDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "external_id": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "format": "double"
          },
          "total": {
            "type": "number",
            "format": "double"
          },
          "tax": {
            "type": "number",
            "format": "double"
          },
          "tax_rate": {
            "type": "string",
            "nullable": true
          },
          "commodity_code": {
            "type": "string",
            "nullable": true
          },
          "unit_of_measure": {
            "type": "string",
            "nullable": true
          },
          "unit_of_cost": {
            "type": "string",
            "nullable": true
          },
          "tax_name": {
            "type": "string",
            "nullable": true
          },
          "tax_description": {
            "type": "string",
            "nullable": true
          },
          "duty": {
            "type": "number",
            "format": "double"
          },
          "discount": {
            "type": "number",
            "format": "double"
          },
          "duty_name": {
            "type": "string",
            "nullable": true
          },
          "duty_description": {
            "type": "string",
            "nullable": true
          },
          "shipping": {
            "type": "number",
            "format": "double"
          },
          "ship_from_postal_code": {
            "type": "string",
            "nullable": true
          },
          "shipping_name": {
            "type": "string",
            "nullable": true
          },
          "shipping_description": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OpenPath.V5.Data.Dto.Transaction.MetadataDto": {
        "type": "object",
        "properties": {
          "attribute": {
            "maxLength": 64,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "value": {
            "nullable": true
          },
          "value_type": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.Enumerator.MetadataValueTypeEnumerator"
          }
        },
        "additionalProperties": false,
        "example": {
          "attribute": "OpenPath.MetaData.OrderSource",
          "value": "web-checkout",
          "value_type": "String"
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.RecurringDto": {
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 1024,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "recurring_type": {
            "maxLength": 50,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "initial": {
            "type": "boolean"
          },
          "payments": {
            "maximum": 2147483647,
            "minimum": 0,
            "type": "integer",
            "format": "int32"
          },
          "amount": {
            "minimum": 0,
            "type": "number",
            "format": "double"
          },
          "frequency_unit": {
            "maxLength": 50,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "frequency": {
            "maximum": 2147483647,
            "minimum": 0,
            "type": "integer",
            "format": "int32"
          },
          "billing_day": {
            "maximum": 31,
            "minimum": 0,
            "type": "integer",
            "format": "int32"
          },
          "start_date": {
            "type": "string",
            "format": "date-time"
          },
          "external_id": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "data_type": {
            "maxLength": 50,
            "minLength": 0,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OpenPath.V5.Data.Dto.Transaction.Response.ServerDto": {
        "type": "object",
        "properties": {
          "packet_id": {
            "type": "integer",
            "format": "int64"
          },
          "server": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "connector_id": {
            "type": "integer",
            "format": "int64"
          },
          "connector_name": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "connector_provider": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OpenPath.V5.Data.Dto.Transaction.Response.TransactionResponseDto": {
        "type": "object",
        "properties": {
          "capture": {
            "type": "boolean"
          },
          "transaction_id": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "transaction_customer": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "transaction_terminal": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "token": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "credit_card": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.CreditCardDto"
          },
          "customer": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.CustomerDto"
          },
          "detail": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.TransactionDetailDto"
          },
          "split_settlement": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.SplitSettlementDto"
          },
          "metadata": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.MetadataDto"
            },
            "nullable": true
          },
          "decline_recapture": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.DeclineRecaptureDto"
          },
          "result": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.Response.TransactionResultDto"
          },
          "server": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.Response.ServerDto"
          }
        },
        "additionalProperties": false,
        "example": {
          "result": {
            "transaction_id": "12088864608",
            "transaction_id_reference": "12088864607",
            "authorization_code": "123456",
            "status": "Approved",
            "code": "100",
            "message": "100 | SUCCESS",
            "cvv_code": "M",
            "cvv_message": "Match",
            "avs_code": "Y",
            "avs_message": "Exact match"
          },
          "capture": false,
          "credit_card": {
            "name_on_card": "Avery Johnson",
            "expiration_month": 12,
            "expiration_year": 2030,
            "type": "CREDIT",
            "last_four": "1111",
            "longitude": 0,
            "latitude": 0,
            "bin": "411111",
            "expiration": "2030-12-31T00:00:00",
            "bank": "JPMORGAN CHASE BANK, N.A.",
            "brand": "VISA",
            "country_code_a2": "US",
            "country_name": "United States",
            "billing_address": {
              "address_line1": "475 Market Street",
              "address_line2": "Suite 2200",
              "city": "San Francisco",
              "region": "CA",
              "postal_code": "94105",
              "country": "US"
            }
          },
          "customer": {
            "id": 75253,
            "first_name": "Avery",
            "last_name": "Johnson",
            "email_address": "avery.johnson@example.com",
            "phone_number": "+14155550199",
            "shipping_address": {
              "address_line1": "475 Market Street",
              "address_line2": "Suite 2200",
              "city": "San Francisco",
              "region": "CA",
              "postal_code": "94105",
              "country": "US"
            }
          },
          "detail": {
            "amount": 99.31,
            "order_id": "ORD-20260521-1001",
            "currency": "USD",
            "surcharge": 0,
            "tip": 0,
            "shipping": 4.99,
            "tax": 8.19,
            "description": "Gold Plan subscription",
            "is_mit": false,
            "line_items": [
              {
                "id": 1,
                "external_id": "sku_gold_plan",
                "name": "Gold Plan",
                "description": "Monthly Gold subscription",
                "quantity": 1,
                "total": 86.13,
                "tax": 8.19,
                "tax_rate": "0.095",
                "commodity_code": "SUBSCRIPTION",
                "unit_of_measure": "EA",
                "unit_of_cost": "86.13",
                "tax_name": "Sales Tax",
                "tax_description": "California sales tax",
                "duty": 0,
                "discount": 0,
                "duty_name": "",
                "duty_description": "",
                "shipping": 4.99,
                "ship_from_postal_code": "94105",
                "shipping_name": "Ground",
                "shipping_description": "Standard ground shipping"
              }
            ],
            "standard_entry_class_code": "WEB",
            "ip_address": "198.51.100.42",
            "device": {
              "sense_key": "0b7e7d5d-2f79-4b77-9e4f-7e1f6ec91d5b",
              "type": "MOBILE",
              "name": "iPhone 15 Pro",
              "os": "iOS 18",
              "browser": "Mobile Safari",
              "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Mobile/15E148 Safari/604.1",
              "language": "en-US",
              "screen": "1179x2556 3x",
              "timezone": "America/Los_Angeles"
            },
            "recurring": {
              "name": "Monthly subscription - Gold Plan",
              "recurring_type": "OPENPATH",
              "initial": true,
              "payments": 12,
              "amount": 49.99,
              "frequency_unit": "MONTHS",
              "frequency": 1,
              "billing_day": 15,
              "start_date": "2026-06-15T00:00:00",
              "external_id": "sub_gold_1001",
              "data_type": "ADDPLAN"
            }
          },
          "metadata": [
            {
              "attribute": "OpenPath.MetaData.OrderSource",
              "value": "web-checkout",
              "value_type": "String"
            },
            {
              "attribute": "OpenPath.MetaData.Campaign",
              "value": "spring-promo",
              "value_type": "String"
            }
          ],
          "decline_recapture": {
            "decline_code": "05",
            "decline_description": "Do not honor",
            "decline_source": "issuer",
            "decline_avs_code": "N",
            "decline_cvv_code": "M",
            "decline_cavv_code": "2",
            "network_schema_id": "123456789",
            "network_schema": "VISA"
          },
          "server": {
            "packet_id": 123608,
            "server": "Api.Standard",
            "connector_id": 437,
            "connector_name": "nmi-test",
            "connector_provider": "NMI"
          }
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.Response.TransactionResultDto": {
        "required": [
          "status",
          "transaction_id"
        ],
        "type": "object",
        "properties": {
          "transaction_id": {
            "minLength": 1,
            "type": "string"
          },
          "transaction_id_reference": {
            "type": "string",
            "nullable": true
          },
          "authorization_code": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "minLength": 1,
            "type": "string"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string",
            "nullable": true
          },
          "cvv_code": {
            "type": "string",
            "nullable": true
          },
          "cvv_message": {
            "type": "string",
            "nullable": true
          },
          "avs_code": {
            "type": "string",
            "nullable": true
          },
          "avs_message": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "transaction_id": "12088864608",
          "authorization_code": "123456",
          "status": "Approved",
          "code": "100",
          "message": "100 | SUCCESS"
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.StatusErrorDto": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32"
          },
          "errors": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "nullable": true
          },
          "traceId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "type": "https://httpstatuses.com/400",
          "title": "Bad request",
          "status": 400,
          "errors": {
            "detail.amount": [
              "Amount must be greater than 0."
            ],
            "metadata[0].attribute": [
              "Attribute is required."
            ]
          },
          "traceId": "00-3d4a6b8c4b384f9c8d09d7d4f59c1c8e-4ad4b1f8b6fd6c6c-00"
        }
      },
      "OpenPath.V5.Data.Dto.Transaction.TransactionDetailDto": {
        "type": "object",
        "properties": {
          "amount": {
            "minimum": 0,
            "type": "number",
            "format": "double"
          },
          "order_id": {
            "maxLength": 64,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "is_mit": {
            "type": "boolean",
            "nullable": true
          },
          "currency": {
            "maxLength": 3,
            "minLength": 3,
            "type": "string",
            "nullable": true
          },
          "surcharge": {
            "minimum": 0,
            "type": "number",
            "format": "double"
          },
          "tip": {
            "minimum": 0,
            "type": "number",
            "format": "double"
          },
          "shipping": {
            "minimum": 0,
            "type": "number",
            "format": "double"
          },
          "tax": {
            "minimum": 0,
            "type": "number",
            "format": "double"
          },
          "description": {
            "maxLength": 255,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "line_items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.LineItemDto"
            },
            "nullable": true
          },
          "standard_entry_class_code": {
            "type": "string",
            "nullable": true
          },
          "ip_address": {
            "pattern": "^((\\d{1,3}\\.){3}\\d{1,3}|(([a-fA-F\\d]{1,4}:){1,7}[a-fA-F\\d]{1,4}|::1))$",
            "type": "string",
            "nullable": true
          },
          "device": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.TransactionDeviceDto"
          },
          "recurring": {
            "$ref": "#/components/schemas/OpenPath.V5.Data.Dto.Transaction.RecurringDto"
          }
        },
        "additionalProperties": false
      },
      "OpenPath.V5.Data.Dto.Transaction.TransactionDeviceDto": {
        "type": "object",
        "properties": {
          "sense_key": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "type": {
            "maxLength": 50,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "name": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "os": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "browser": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "user_agent": {
            "maxLength": 1024,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "language": {
            "maxLength": 35,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "screen": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "sense_key": "0b7e7d5d-2f79-4b77-9e4f-7e1f6ec91d5b",
          "type": "MOBILE",
          "name": "iPhone 15 Pro",
          "os": "iOS 18",
          "browser": "Mobile Safari",
          "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Mobile/15E148 Safari/604.1",
          "language": "en-US",
          "screen": "1179x2556 3x",
          "timezone": "America/Los_Angeles"
        }
      }
    }
  },
  "security": [
    {}
  ]
}
```