Identification

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/tracetail-io/json-schema/tracetail-io-identification-schema.json",
  "title": "Identification",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/tracetail-io-openapi.json#/components/schemas/Identification",
  "type": "object",
  "required": [
    "requestId",
    "visitorId",
    "confidence",
    "quality",
    "verification",
    "isBot"
  ],
  "properties": {
    "requestId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of one registered identification."
    },
    "visitorId": {
      "type": "string",
      "pattern": "^(?:fp3_|(?:free_)?fp2_)[0-9a-f]{16}$",
      "description": "`fp3_` followed by 16 hex characters, computed by the TraceTail SDK (IDs from 2.x SDKs start with `fp2_`)."
    },
    "confidence": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "deprecated": true,
      "description": "Alias of quality.score, not match probability."
    },
    "quality": {
      "type": "object",
      "required": [
        "score",
        "reasons"
      ],
      "description": "Signal completeness, not match probability or physical-device uniqueness.",
      "properties": {
        "score": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "reasons": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "verification": {
      "type": "string",
      "enum": [
        "consistent",
        "unverified"
      ],
      "description": "consistent means the server recomputed the ID from the signals. It does not authenticate a device. Legacy requests are unverified."
    },
    "isBot": {
      "type": "boolean",
      "description": "True for automated browsers: a headless user agent or navigator.webdriver."
    }
  }
}