{ "openapi": "3.1.0", "info": { "title": "Foil API", "version": "2026-03-25", "description": "Customer-facing Foil server APIs for sessions, visitor fingerprints, organizations, and API keys." }, "servers": [ { "url": "https://api.usefoil.com", "description": "Production" } ], "tags": [ { "name": "Sessions", "description": "Session readback endpoints." }, { "name": "Visitor fingerprints", "description": "Visitor fingerprint readback endpoints." }, { "name": "Organizations", "description": "Organization lifecycle endpoints." }, { "name": "API Keys", "description": "Organization API key lifecycle endpoints." }, { "name": "Webhooks", "description": "Manage webhook endpoints, subscriptions, and outgoing event delivery." }, { "name": "Events", "description": "Inspect organization events and their webhook delivery attempts." } ], "paths": { "/v1/agents/ip-rotation": { "post": { "tags": [ "Agents" ], "operationId": "checkAgentIpRotation", "summary": "Check whether an agent should rotate its IP", "description": "Requires the database-controlled organization entitlement and the `agents:ip_rotation` secret-key scope. Each submitted IP consumes one secret-key rate-limit unit, so a 10-item batch costs 10 units. The response reports that cost in `X-RateLimit-Cost`.", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentIpRotationRequest" } } } }, "responses": { "200": { "description": "Ordered agent IP rotation decisions.", "headers": { "X-RateLimit-Cost": { "description": "Rate-limit units charged for this request; equal to the number of submitted IPs.", "schema": { "type": "integer", "minimum": 1, "maximum": 10 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentIpRotationResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "403": { "description": "A secret key with the agents:ip_rotation scope is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "404": { "description": "The endpoint is not enabled for this organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "422": { "description": "Invalid batch size, IP address, proxy provider tag, or desired country code.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "429": { "description": "Rate limit exceeded. Each submitted IP consumes one unit; honor Retry-After before retrying.", "headers": { "X-RateLimit-Cost": { "description": "Rate-limit units attempted by this request; equal to the number of submitted IPs.", "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }, "Retry-After": { "description": "Seconds until the next acceptable retry.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "503": { "description": "IP intelligence is temporarily unavailable or incomplete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } } } } }, "/v1/sessions": { "get": { "tags": [ "Sessions" ], "operationId": "listSessions", "summary": "List sessions", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50, "example": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "example": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, { "name": "verdict", "in": "query", "schema": { "$ref": "#/components/schemas/Verdict", "example": "human" } }, { "name": "search", "in": "query", "schema": { "type": "string", "example": "arm" } } ], "responses": { "200": { "description": "Session list response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionListResponse", "example": { "data": [ { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Secret key required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `sessions:list` secret-key scope." } }, "/v1/sessions/{sessionId}": { "get": { "tags": [ "Sessions" ], "operationId": "getSession", "summary": "Retrieve one session", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SessionId", "example": "sid_87wfetm98myh9awj0dpt28a3kc" } } ], "responses": { "200": { "description": "Session detail response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDetailResponse", "example": { "data": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" }, "highlights": [ { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } ], "web_bot_auth": { "status": "verified", "domain": "browserless.io" }, "network": { "ip_address": "203.0.113.10", "ip_version": "ipv4", "status": "ready", "summary": "Browser is being driven by automation", "location": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 }, "routing": { "asn": "64512", "organization": "SPECTRANET LIMITED" }, "anonymity": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" }, "reputation": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false }, "evidence": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 }, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "runtime_integrity": { "tampering": "high_risk", "developer_tools": "high_risk", "emulation": "clean", "virtualization": "high_risk", "privacy_hardening": "notice", "identity_spoofing": "clean", "replay": "clean", "outdated_environment": "clean" }, "native_runtime_integrity": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } }, "native_app": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" }, "native_carrier": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] }, "native_motion_print": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "device_identity": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] }, "install_id": "install_id", "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } }, "connection_fingerprint": { "ja4": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, "http2": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" }, "user_agent_alignment": "match" }, "previous_decisions": [ { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } ], "request": { "url": "https://app.acme.co/signup", "referrer": "https://app.acme.co/", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "browser": { "name": "Chromium", "version": "123.0.0.0", "major_version": "123", "engine": "blink", "app_name": null }, "device": { "form_factor": "desktop", "operating_system": { "name": "macOS", "version": "123.0.0.0" }, "architecture": "arm", "screen": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" }, "locale": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] }, "capabilities": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } }, "analysis_coverage": { "browser": true, "device": true, "network": true, "runtime": true, "behavioral": true, "visitor_identity": true }, "signals_fired": [ { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } ], "client_telemetry": { "navigator": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] }, "storage": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "canvas": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true }, "graphics": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "audio": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true }, "fonts": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 }, "media": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } }, "attribution": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] }, "behavior": null }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Secret key required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Session not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `sessions:read` secret-key scope." }, "patch": { "tags": [ "Sessions" ], "operationId": "updateSession", "summary": "Update a session", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SessionId", "example": "sid_87wfetm98myh9awj0dpt28a3kc" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSessionRequest" } } } }, "responses": { "200": { "description": "Updated session detail response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDetailResponse" } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "403": { "description": "Secret key missing the required `sessions:update` scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "404": { "description": "Session not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } }, "422": { "description": "Invalid update payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope" } } } } }, "description": "Set or clear the customer-supplied `client_user_id` for a session. Requires the `sessions:update` secret-key scope." } }, "/v1/fingerprints": { "get": { "tags": [ "Visitor fingerprints" ], "operationId": "listVisitorFingerprints", "summary": "List visitor fingerprints", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50, "example": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "example": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, { "name": "search", "in": "query", "schema": { "type": "string", "example": "arm" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "seen_count", "first_seen" ], "example": "seen_count" } } ], "responses": { "200": { "description": "Visitor fingerprint list response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorFingerprintListResponse", "example": { "data": [ { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Secret key required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `fingerprints:list` secret-key scope." } }, "/v1/fingerprints/{visitorId}": { "get": { "tags": [ "Visitor fingerprints" ], "operationId": "getVisitorFingerprint", "summary": "Retrieve one visitor fingerprint", "parameters": [ { "name": "visitorId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FingerprintId", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" } } ], "responses": { "200": { "description": "Visitor fingerprint detail response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorFingerprintDetailResponse", "example": { "data": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" }, "components": { "vector": [ 1.5 ] }, "activity": { "sessions": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Secret key required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Visitor fingerprint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `fingerprints:read` secret-key scope." } }, "/v1/organizations": { "post": { "tags": [ "Organizations" ], "operationId": "createOrganization", "summary": "Create an organization", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest", "example": { "name": "Acme Growth Workspace", "slug": "acme-growth" } } } } }, "responses": { "201": { "description": "Organization created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse", "example": { "data": { "object": "organization", "id": "org_f6m39y94nh6fs513q03skj929c", "name": "Acme Growth Workspace", "slug": "acme-growth", "status": "active", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Secret key required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "409": { "description": "Conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `organizations:create` secret-key scope." } }, "/v1/organizations/{organizationId}": { "get": { "tags": [ "Organizations" ], "operationId": "getOrganization", "summary": "Retrieve one organization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } } ], "responses": { "200": { "description": "Organization response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse", "example": { "data": { "object": "organization", "id": "org_f6m39y94nh6fs513q03skj929c", "name": "Acme Growth Workspace", "slug": "acme-growth", "status": "active", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Organization not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `organizations:read` secret-key scope." }, "patch": { "tags": [ "Organizations" ], "operationId": "updateOrganization", "summary": "Update a organization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest", "example": { "name": "Acme Growth Workspace", "status": "active" } } } } }, "responses": { "200": { "description": "Updated organization response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse", "example": { "data": { "object": "organization", "id": "org_f6m39y94nh6fs513q03skj929c", "name": "Acme Growth Workspace", "slug": "acme-growth", "status": "active", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Organization not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `organizations:update` secret-key scope." } }, "/v1/organizations/{organizationId}/api-keys": { "get": { "tags": [ "API Keys" ], "operationId": "listOrganizationApiKeys", "summary": "List organization API keys", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50, "example": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string", "example": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } } ], "responses": { "200": { "description": "API key list response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyListResponse", "example": { "data": [ { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Organization not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `api_keys:read` secret-key scope." }, "post": { "tags": [ "API Keys" ], "operationId": "createOrganizationApiKey", "summary": "Create an organization API key", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest", "example": { "name": "Production backend", "type": "secret", "environment": "live", "scopes": [ "sessions:read", "sessions:update", "fingerprints:read" ] } } } } }, "responses": { "201": { "description": "Issued API key response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedApiKeyResponse", "example": { "data": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Organization not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `api_keys:manage` secret-key scope." } }, "/v1/organizations/{organizationId}/api-keys/{keyId}": { "delete": { "tags": [ "API Keys" ], "operationId": "revokeOrganizationApiKey", "summary": "Revoke a organization API key", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ApiKeyId", "example": "key_6cw04zdmetw8t5rsdppadhper0" } } ], "responses": { "200": { "description": "Revoked API key response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse", "example": { "data": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "API key not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `api_keys:manage` secret-key scope." }, "patch": { "tags": [ "API Keys" ], "operationId": "updateOrganizationApiKey", "summary": "Update an organization API key", "description": "Requires the `api_keys:manage` secret-key scope.", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ApiKeyId", "example": "key_6cw04zdmetw8t5rsdppadhper0" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest", "example": { "name": "Acme Growth Workspace", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ] } } } } }, "responses": { "200": { "description": "Revoked API key response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse", "example": { "data": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "API key not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } }, "/v1/organizations/{organizationId}/api-keys/{keyId}/rotations": { "post": { "tags": [ "API Keys" ], "operationId": "rotateOrganizationApiKey", "summary": "Rotate a organization API key", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ApiKeyId", "example": "key_6cw04zdmetw8t5rsdppadhper0" } } ], "responses": { "201": { "description": "Rotated API key response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedApiKeyResponse", "example": { "data": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "API key not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } }, "description": "Requires the `api_keys:manage` secret-key scope." } }, "/v1/organizations/{organizationId}/webhooks/endpoints": { "get": { "tags": [ "Webhooks" ], "operationId": "listWebhookEndpoints", "summary": "List webhook endpoints", "description": "Requires Authorization: Bearer sk_* with the webhooks:read scope.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } } ], "responses": { "200": { "description": "Webhook endpoint list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointListResponse", "example": { "data": [ { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } }, "post": { "tags": [ "Webhooks" ], "operationId": "createWebhookEndpoint", "summary": "Create a webhook endpoint", "description": "Requires Authorization: Bearer sk_* with the webhooks:manage scope. The signing_secret is returned only in this response and rotation responses.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookEndpointRequest", "example": { "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "event_types": [ "session.result.persisted" ] } } } } }, "responses": { "201": { "description": "Webhook endpoint created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse", "example": { "data": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Invalid webhook endpoint payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } }, "/v1/organizations/{organizationId}/webhooks/endpoints/{endpointId}": { "patch": { "tags": [ "Webhooks" ], "operationId": "updateWebhookEndpoint", "summary": "Update a webhook endpoint", "description": "Requires Authorization: Bearer sk_* with the webhooks:manage scope. Updating event_types replaces the endpoint subscriptions.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointRequest", "example": { "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ] } } } } }, "responses": { "200": { "description": "Webhook endpoint updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse", "example": { "data": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Webhook endpoint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Invalid webhook endpoint payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } }, "delete": { "tags": [ "Webhooks" ], "operationId": "disableWebhookEndpoint", "summary": "Disable a webhook endpoint", "description": "Requires Authorization: Bearer sk_* with the webhooks:manage scope.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" } } ], "responses": { "200": { "description": "Webhook endpoint disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse", "example": { "data": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Webhook endpoint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } }, "/v1/organizations/{organizationId}/webhooks/endpoints/{endpointId}/rotations": { "post": { "tags": [ "Webhooks" ], "operationId": "rotateWebhookEndpointSecret", "summary": "Rotate a webhook signing secret", "description": "Requires Authorization: Bearer sk_* with the webhooks:manage scope. The new signing_secret is returned only in this response.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" } } ], "responses": { "201": { "description": "Webhook endpoint secret rotated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse", "example": { "data": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Webhook endpoint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } }, "/v1/organizations/{organizationId}/webhooks/endpoints/{endpointId}/test": { "post": { "tags": [ "Webhooks" ], "operationId": "sendTestWebhook", "summary": "Send a test webhook", "description": "Requires Authorization: Bearer sk_* with the webhooks:manage scope. Enqueues a webhook.test delivery for the selected endpoint.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" } } ], "responses": { "202": { "description": "Test webhook delivery enqueued.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestResponse", "example": { "data": { "object": "webhook_test", "event_id": "wevt_0123456789abcdef0123456789abcdef", "delivery_ids": [ "wdlv_0123456789abcdef0123456789abcdef" ], "latest_delivery": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Webhook endpoint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } }, "/v1/organizations/{organizationId}/events": { "get": { "tags": [ "Events" ], "operationId": "listEvents", "summary": "List events", "description": "List organization events. Requires Authorization: Bearer sk_* with the webhooks:read scope.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "endpoint_id", "in": "query", "required": false, "description": "Only return events that produced a delivery for this webhook endpoint.", "schema": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" } }, { "name": "type", "in": "query", "required": false, "description": "Only return events of this type.", "schema": { "$ref": "#/components/schemas/WebhookDeliveryEventType", "example": "session.result.persisted" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50, "example": 50 } } ], "responses": { "200": { "description": "Events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventListResponse", "example": { "data": [ { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "422": { "description": "Invalid event list query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } }, "/v1/organizations/{organizationId}/events/{eventId}": { "get": { "tags": [ "Events" ], "operationId": "retrieveEvent", "summary": "Retrieve an event", "description": "Retrieve one organization event and its webhook delivery attempts. Requires Authorization: Bearer sk_* with the webhooks:read scope.", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" } }, { "name": "eventId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookEventId", "example": "wevt_0123456789abcdef0123456789abcdef" } } ], "responses": { "200": { "description": "Event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventResponse", "example": { "data": { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } } } } }, "401": { "description": "Missing or invalid API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "403": { "description": "Organization access denied or insufficient scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } }, "404": { "description": "Event not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorEnvelope", "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } } } } } } } } }, "components": { "schemas": { "AgentIpRotationRequest": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "items": { "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/AgentIpRotationItem" } } } }, "AgentIpRotationItem": { "type": "object", "additionalProperties": false, "required": [ "ip", "proxy_provider", "desired_country_code" ], "properties": { "ip": { "type": "string", "description": "Globally routable IPv4 or IPv6 address currently assigned to the agent.", "example": "8.8.8.8" }, "proxy_provider": { "type": "string", "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$", "maxLength": 128, "description": "Uppercase snake-case provider tag from Foil's operator catalog. Foil matches the tag exactly and accepts catalogued aliases such as `BYTEFUL_DATA`, but never infers a suffix from a shared stem. The Agent IP rotation page lists the accepted tags. Foil records the tag with the sighting; it does not influence `should_cycle`.", "example": "BYTEFUL" }, "desired_country_code": { "$ref": "#/components/schemas/IsoCountryCode" } } }, "AgentIpRotationResponse": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "items": { "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/AgentIpRotationResult" } } } }, "AgentIpRotationResult": { "type": "object", "additionalProperties": false, "required": [ "ip", "proxy_provider", "proxy_provider_brand", "desired_country_code", "observed_country_code", "country_matches", "should_cycle" ], "properties": { "ip": { "type": "string", "example": "8.8.8.8" }, "proxy_provider": { "type": "string", "description": "The submitted provider tag.", "example": "BYTEFUL" }, "proxy_provider_brand": { "type": "string", "pattern": "^[A-Z0-9]+(?:_[A-Z0-9]+)*$", "description": "Canonical catalog brand key the submitted tag resolved to. Use this key in future requests.", "example": "BYTEFUL" }, "desired_country_code": { "$ref": "#/components/schemas/IsoCountryCode" }, "observed_country_code": { "anyOf": [ { "$ref": "#/components/schemas/IsoCountryCode" }, { "type": "null" } ], "description": "Country code observed by Foil IP intelligence, or null when it cannot be confirmed." }, "country_matches": { "type": "boolean", "description": "Whether the observed country matches the desired country.", "example": true }, "should_cycle": { "type": "boolean", "description": "Whether the caller should discard this IP and request another one. Known anonymizers, proxies, relays, residential proxies, VPNs, Tor exits, botnet exits, hosting networks, suspicious networks, and a confirmed country different from the desired one require cycling. An unconfirmed country does not.", "example": true } } }, "IsoCountryCode": { "type": "string", "description": "Uppercase ISO 3166-1 alpha-2 country code.", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "example": "US" }, "SessionId": { "type": "string", "pattern": "^sid_[0123456789abcdefghjkmnpqrstvwxyz]{26}$", "example": "sid_87wfetm98myh9awj0dpt28a3kc" }, "EventId": { "type": "string", "pattern": "^evt_[0123456789abcdefghjkmnpqrstvwxyz]{26}$", "example": "evt_srwqc0yqhz4bxvtrdtf69q7vkr" }, "FingerprintId": { "type": "string", "pattern": "^vid_[0123456789abcdefghjkmnpqrstvwxyz]{26}$", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "OrganizationId": { "type": "string", "pattern": "^org_[0123456789abcdefghjkmnpqrstvwxyz]{26}$", "example": "org_f6m39y94nh6fs513q03skj929c" }, "ApiKeyId": { "type": "string", "pattern": "^key_[0123456789abcdefghjkmnpqrstvwxyz]{26}$", "example": "key_6cw04zdmetw8t5rsdppadhper0" }, "RequestId": { "type": "string", "pattern": "^req_[0-9a-f]{32}$", "example": "req_cf147349a4134208aebb8c70e25fb7e1" }, "Verdict": { "type": "string", "enum": [ "bot", "human", "inconclusive" ], "example": "human" }, "Phase": { "type": "string", "enum": [ "snapshot", "behavioral" ], "example": "snapshot" }, "ManipulationVerdict": { "type": "string", "enum": [ "none", "low", "medium", "high" ], "example": "none" }, "OrganizationStatus": { "type": "string", "enum": [ "active", "suspended", "deleted" ], "example": "active" }, "ApiKeyStatus": { "type": "string", "enum": [ "active", "rotating", "revoked" ], "example": "active" }, "ApiKeyEnvironment": { "type": "string", "enum": [ "live", "test" ], "example": "live" }, "ApiKeyClientTarget": { "type": "string", "enum": [ "browser", "native-ios", "native-android" ], "example": "browser" }, "KnownPublicErrorCode": { "type": "string", "enum": [ "auth.invalid_api_key", "auth.invalid_bearer_token", "auth.missing_api_key", "auth.missing_bearer_token", "auth.origin_not_allowed", "auth.secret_key_not_allowed", "auth.secret_key_required", "auth.organization_access_denied", "auth.organization_inactive", "internal.unavailable", "rate_limit.exceeded", "request.conflict", "request.invalid_content_type", "request.invalid_json", "request.not_found", "request.payload_too_large", "request.validation_failed", "session.invalid_or_expired", "session.invalid_state", "session.nonce_consumed", "session.sequence_mismatch", "transport.session_reset_required", "transport.upgrade_required" ], "example": "auth.invalid_api_key" }, "ResponseMeta": { "type": "object", "additionalProperties": false, "required": [ "request_id" ], "properties": { "request_id": { "$ref": "#/components/schemas/RequestId", "example": "req_cf147349a4134208aebb8c70e25fb7e1" } }, "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } }, "CursorPagination": { "type": "object", "additionalProperties": false, "required": [ "limit", "has_more" ], "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 200, "example": 50 }, "has_more": { "type": "boolean", "example": false }, "next_cursor": { "type": "string", "example": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "ApiFieldIssue": { "type": "object", "additionalProperties": false, "required": [ "name", "issue" ], "properties": { "name": { "type": "string", "example": "Acme Growth Workspace" }, "issue": { "type": "string", "example": "required" }, "expected": { "type": "string", "example": "string" }, "received": { "anyOf": [ { "type": "string", "example": "0" }, { "type": "number", "example": 1.5 }, { "type": "boolean", "example": true }, { "type": "null", "example": null } ], "example": "any_of" } }, "example": { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } }, "ApiErrorDetails": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ApiFieldIssue", "example": { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } }, "example": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ] }, "allowed_values": { "type": "array", "items": { "type": "string", "example": "verified" }, "example": [ "verified" ] }, "header_name": { "type": "string", "example": "x-forwarded-for" }, "parameter_set": { "type": "string", "example": "browser_fingerprint" }, "next_action": { "type": "string", "enum": [ "retry", "new_session", "reload_bundle", "contact_support" ], "example": "retry" } }, "additionalProperties": true, "example": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } }, "PublicError": { "type": "object", "additionalProperties": false, "required": [ "code", "message", "status", "retryable", "request_id" ], "properties": { "code": { "type": "string", "x-foil-known-values-ref": "#/components/schemas/KnownPublicErrorCode", "example": "request.validation_failed" }, "message": { "type": "string", "example": "Observation payload failed validation." }, "status": { "type": "integer", "example": 1 }, "retryable": { "type": "boolean", "example": true }, "request_id": { "$ref": "#/components/schemas/RequestId", "example": "req_cf147349a4134208aebb8c70e25fb7e1" }, "docs_url": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "details": { "$ref": "#/components/schemas/ApiErrorDetails", "example": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } }, "example": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } }, "ApiErrorEnvelope": { "type": "object", "additionalProperties": false, "required": [ "error" ], "properties": { "error": { "$ref": "#/components/schemas/PublicError", "example": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } }, "example": { "error": { "code": "request.validation_failed", "message": "Observation payload failed validation.", "status": 1, "retryable": true, "request_id": "req_cf147349a4134208aebb8c70e25fb7e1", "docs_url": "https://app.acme.co/signup", "details": { "fields": [ { "name": "Acme Growth Workspace", "issue": "required", "expected": "string", "received": "any_of" } ], "allowed_values": [ "verified" ], "header_name": "x-forwarded-for", "parameter_set": "browser_fingerprint", "next_action": "retry" } } } }, "ManipulationSummary": { "type": "object", "additionalProperties": false, "required": [ "score", "verdict" ], "properties": { "score": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100, "example": 1 }, { "type": "null", "example": null } ], "example": 1 }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/ManipulationVerdict", "example": "none" }, { "type": "null", "example": null } ], "example": "none" } }, "example": { "score": 1, "verdict": "none" } }, "Decision": { "type": "object", "additionalProperties": false, "required": [ "event_id", "verdict", "risk_score", "phase", "is_provisional", "manipulation", "evaluation_duration_ms", "evaluated_at" ], "properties": { "event_id": { "$ref": "#/components/schemas/EventId", "example": "evt_srwqc0yqhz4bxvtrdtf69q7vkr" }, "verdict": { "$ref": "#/components/schemas/Verdict", "example": "human" }, "risk_score": { "type": "integer", "minimum": 0, "maximum": 100, "example": 94 }, "phase": { "$ref": "#/components/schemas/Phase", "example": "snapshot" }, "is_provisional": { "type": "boolean", "example": false }, "manipulation": { "anyOf": [ { "$ref": "#/components/schemas/ManipulationSummary", "example": { "score": 1, "verdict": "none" } }, { "type": "null", "example": null } ], "example": { "score": 1, "verdict": "none" } }, "evaluation_duration_ms": { "type": "integer", "minimum": 0, "example": 123 }, "evaluated_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "RequestContext": { "type": "object", "additionalProperties": false, "required": [ "url", "user_agent", "ip_address", "screen_size", "is_touch_capable" ], "properties": { "url": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "user_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "ip_address": { "type": "string", "example": "203.0.113.10" }, "screen_size": { "type": [ "string", "null" ], "example": "1440x900" }, "is_touch_capable": { "type": [ "boolean", "null" ], "example": true } }, "example": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true } }, "VisitorFingerprintLink": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "confidence", "identified_at" ], "properties": { "object": { "const": "visitor_fingerprint", "example": "visitor_fingerprint" }, "id": { "$ref": "#/components/schemas/FingerprintId", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "confidence": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100, "example": 1 }, { "type": "null", "example": null } ], "example": 1 }, "identified_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } }, "NetworkSummary": { "type": "object", "additionalProperties": false, "required": [ "ip" ], "properties": { "ip": { "anyOf": [ { "type": "object", "additionalProperties": true, "example": { "source": "signup_form" } }, { "type": "null", "example": null } ], "example": { "source": "signup_form" } } }, "example": { "ip": { "source": "signup_form" } } }, "SessionSummary": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "created_at", "latest_decision", "visitor_fingerprint", "client_user_id" ], "properties": { "object": { "const": "session", "example": "session" }, "id": { "$ref": "#/components/schemas/SessionId", "example": "sid_87wfetm98myh9awj0dpt28a3kc" }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "client_user_id": { "type": [ "string", "null" ], "maxLength": 256, "description": "Customer-supplied identifier for the end user associated with this Foil session. Set with PATCH /v1/sessions/{sessionId}.", "example": "user_123" }, "latest_decision": { "$ref": "#/components/schemas/Decision", "example": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "visitor_fingerprint": { "anyOf": [ { "$ref": "#/components/schemas/VisitorFingerprintLink", "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } }, { "type": "null", "example": null } ], "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } }, "example": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } }, "SessionDetail": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "created_at", "decision", "highlights", "attribution", "web_bot_auth", "network", "runtime_integrity", "native_runtime_integrity", "native_app", "native_carrier", "native_motion_print", "device_identity", "install_id", "visitor_fingerprint", "connection_fingerprint", "previous_decisions", "request", "browser", "device", "analysis_coverage", "signals_fired", "client_telemetry", "client_user_id", "behavior" ], "properties": { "object": { "const": "session", "example": "session" }, "id": { "$ref": "#/components/schemas/SessionId", "example": "sid_87wfetm98myh9awj0dpt28a3kc" }, "created_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "client_user_id": { "type": [ "string", "null" ], "maxLength": 256, "description": "Customer-supplied identifier for the end user associated with this Foil session. Set with PATCH /v1/sessions/{sessionId}.", "example": "user_123" }, "decision": { "$ref": "#/components/schemas/SessionDetailDecision", "example": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "highlights": { "type": "array", "items": { "$ref": "#/components/schemas/SessionHighlight", "example": { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } }, "example": [ { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } ] }, "web_bot_auth": { "anyOf": [ { "$ref": "#/components/schemas/SessionWebBotAuth", "example": { "status": "verified", "domain": "browserless.io" } }, { "type": "null", "example": null } ], "example": { "status": "verified", "domain": "browserless.io" } }, "network": { "$ref": "#/components/schemas/SessionNetwork", "example": { "ip_address": "203.0.113.10", "ip_version": "ipv4", "status": "ready", "summary": "Browser is being driven by automation", "location": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 }, "routing": { "asn": "64512", "organization": "SPECTRANET LIMITED" }, "anonymity": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" }, "reputation": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false }, "evidence": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 }, "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "runtime_integrity": { "$ref": "#/components/schemas/SessionRuntimeIntegrity", "example": { "tampering": "high_risk", "developer_tools": "high_risk", "emulation": "clean", "virtualization": "high_risk", "privacy_hardening": "notice", "identity_spoofing": "clean", "replay": "clean", "outdated_environment": "clean" } }, "native_runtime_integrity": { "anyOf": [ { "$ref": "#/components/schemas/SessionNativeRuntimeIntegrity", "example": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } } }, { "type": "null", "example": null } ], "example": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } } }, "native_app": { "anyOf": [ { "$ref": "#/components/schemas/SessionNativeApp", "example": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" } }, { "type": "null", "example": null } ], "example": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" } }, "native_carrier": { "anyOf": [ { "$ref": "#/components/schemas/SessionNativeCarrier", "example": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] } }, { "type": "null", "example": null } ], "example": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] } }, "native_motion_print": { "anyOf": [ { "$ref": "#/components/schemas/SessionNativeMotionPrint", "example": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } } }, { "type": "null", "example": null } ], "example": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } } }, "device_identity": { "anyOf": [ { "$ref": "#/components/schemas/SessionDetailDeviceIdentity", "example": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] } }, { "type": "null", "example": null } ], "example": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] } }, "install_id": { "type": [ "string", "null" ], "example": "install_id" }, "visitor_fingerprint": { "anyOf": [ { "$ref": "#/components/schemas/SessionDetailVisitorFingerprint", "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } } }, { "type": "null", "example": null } ], "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } } }, "connection_fingerprint": { "$ref": "#/components/schemas/SessionConnectionFingerprint", "example": { "ja4": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, "http2": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" }, "user_agent_alignment": "match" } }, "previous_decisions": { "type": "array", "items": { "$ref": "#/components/schemas/SessionDetailDecision", "example": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "example": [ { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } ] }, "request": { "$ref": "#/components/schemas/SessionDetailRequest", "example": { "url": "https://app.acme.co/signup", "referrer": "https://app.acme.co/", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" } }, "browser": { "$ref": "#/components/schemas/SessionBrowser", "example": { "name": "Chromium", "version": "123.0.0.0", "major_version": "123", "engine": "blink", "app_name": null } }, "device": { "$ref": "#/components/schemas/SessionDevice", "example": { "form_factor": "desktop", "operating_system": { "name": "macOS", "version": "123.0.0.0" }, "architecture": "arm", "screen": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" }, "locale": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] }, "capabilities": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } } }, "analysis_coverage": { "$ref": "#/components/schemas/SessionAnalysisCoverage", "example": { "browser": true, "device": true, "network": true, "runtime": true, "behavioral": true, "visitor_identity": true } }, "signals_fired": { "type": "array", "items": { "$ref": "#/components/schemas/SessionSignalFired", "example": { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } }, "example": [ { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } ] }, "client_telemetry": { "$ref": "#/components/schemas/SessionClientTelemetry", "example": { "navigator": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] }, "storage": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "canvas": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true }, "graphics": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "audio": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true }, "fonts": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 }, "media": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } } }, "attribution": { "anyOf": [ { "$ref": "#/components/schemas/SessionAttribution", "example": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] } }, { "type": "null", "example": null } ], "example": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] } }, "behavior": { "anyOf": [ { "$ref": "#/components/schemas/SessionDetailBehavior" }, { "type": "null", "example": null } ], "description": "Per-field behavior-plane ledger: assessment tier and plain-language findings, per-field entry mode/tone/mechanics, and field coverage. Null unless behavior-ledger access is enabled for your organization (off by default).", "example": null } }, "example": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" }, "highlights": [ { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } ], "web_bot_auth": { "status": "verified", "domain": "browserless.io" }, "network": { "ip_address": "203.0.113.10", "ip_version": "ipv4", "status": "ready", "summary": "Browser is being driven by automation", "location": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 }, "routing": { "asn": "64512", "organization": "SPECTRANET LIMITED" }, "anonymity": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" }, "reputation": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false }, "evidence": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 }, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "runtime_integrity": { "tampering": "high_risk", "developer_tools": "high_risk", "emulation": "clean", "virtualization": "high_risk", "privacy_hardening": "notice", "identity_spoofing": "clean", "replay": "clean", "outdated_environment": "clean" }, "native_runtime_integrity": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } }, "native_app": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" }, "native_carrier": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] }, "native_motion_print": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "device_identity": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] }, "install_id": "install_id", "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } }, "connection_fingerprint": { "ja4": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, "http2": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" }, "user_agent_alignment": "match" }, "previous_decisions": [ { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } ], "request": { "url": "https://app.acme.co/signup", "referrer": "https://app.acme.co/", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "browser": { "name": "Chromium", "version": "123.0.0.0", "major_version": "123", "engine": "blink", "app_name": null }, "device": { "form_factor": "desktop", "operating_system": { "name": "macOS", "version": "123.0.0.0" }, "architecture": "arm", "screen": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" }, "locale": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] }, "capabilities": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } }, "analysis_coverage": { "browser": true, "device": true, "network": true, "runtime": true, "behavioral": true, "visitor_identity": true }, "signals_fired": [ { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } ], "client_telemetry": { "navigator": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] }, "storage": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "canvas": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true }, "graphics": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "audio": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true }, "fonts": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 }, "media": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } }, "attribution": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] }, "behavior": null } }, "SessionDetailBehavior": { "type": "object", "additionalProperties": false, "required": [ "assessment", "fields", "coverage" ], "properties": { "assessment": { "$ref": "#/components/schemas/SessionDetailBehaviorAssessment", "example": { "tier": "elevated", "findings": [ "Injected field fill" ] } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SessionDetailBehaviorField" }, "example": [ { "field_hash": 1234567890, "display_name": "Phone number", "field_role": "phone", "entry_mode": "changed_without_input", "tone": "risk", "mechanics": { "input_count": 0, "typed_chars": 0, "paste_count": 0, "correction_count": 0, "dwell_ms": 0, "median_interval_ms": null, "interval_cv": null } } ] }, "coverage": { "type": "object", "additionalProperties": false, "required": [ "fields_tracked", "fields_dropped", "complete" ], "properties": { "fields_tracked": { "type": "number", "example": 3 }, "fields_dropped": { "type": "number", "example": 0 }, "complete": { "type": "boolean", "example": true } }, "example": { "fields_tracked": 3, "fields_dropped": 0, "complete": true } } }, "example": { "assessment": { "tier": "elevated", "findings": [ "Injected field fill" ] }, "fields": [ { "field_hash": 1234567890, "display_name": "Phone number", "field_role": "phone", "entry_mode": "changed_without_input", "tone": "risk", "mechanics": { "input_count": 0, "typed_chars": 0, "paste_count": 0, "correction_count": 0, "dwell_ms": 0, "median_interval_ms": null, "interval_cv": null } } ], "coverage": { "fields_tracked": 3, "fields_dropped": 0, "complete": true } } }, "SessionDetailBehaviorAssessment": { "type": "object", "additionalProperties": false, "required": [ "tier", "findings" ], "properties": { "tier": { "type": "string", "enum": [ "none", "elevated", "high", "unknown" ], "example": "elevated" }, "findings": { "type": "array", "items": { "type": "string", "example": "Injected field fill" }, "example": [ "Injected field fill" ] } }, "example": { "tier": "elevated", "findings": [ "Injected field fill" ] } }, "SessionDetailBehaviorField": { "type": "object", "additionalProperties": false, "required": [ "field_hash", "display_name", "field_role", "entry_mode", "tone", "mechanics" ], "properties": { "field_hash": { "type": "number", "example": 1234567890 }, "display_name": { "type": [ "string", "null" ], "example": "Phone number" }, "field_role": { "type": "string", "example": "phone" }, "entry_mode": { "type": "string", "enum": [ "typed", "typed_with_edits", "typed_and_pasted", "pasted", "autofilled", "prefilled", "changed_without_input", "machine_speed", "scripted_cadence", "filled_instantly", "changed", "visited_no_entry", "unknown" ], "example": "changed_without_input" }, "tone": { "type": "string", "enum": [ "manual", "assisted", "notice", "risk", "neutral" ], "example": "risk" }, "mechanics": { "type": "object", "additionalProperties": false, "required": [ "input_count", "typed_chars", "paste_count", "correction_count", "dwell_ms", "median_interval_ms", "interval_cv" ], "properties": { "input_count": { "type": "number", "example": 6 }, "typed_chars": { "type": "number", "example": 6 }, "paste_count": { "type": "number", "example": 0 }, "correction_count": { "type": "number", "example": 0 }, "dwell_ms": { "type": "number", "example": 1400 }, "median_interval_ms": { "type": [ "number", "null" ], "example": 180 }, "interval_cv": { "type": [ "number", "null" ], "example": 0.42 } }, "example": { "input_count": 6, "typed_chars": 6, "paste_count": 0, "correction_count": 0, "dwell_ms": 1400, "median_interval_ms": 180, "interval_cv": 0.42 } } }, "example": { "field_hash": 1234567890, "display_name": "Phone number", "field_role": "phone", "entry_mode": "changed_without_input", "tone": "risk", "mechanics": { "input_count": 0, "typed_chars": 0, "paste_count": 0, "correction_count": 0, "dwell_ms": 0, "median_interval_ms": null, "interval_cv": null } } }, "VisitorFingerprintLifecycle": { "type": "object", "additionalProperties": false, "required": [ "first_seen_at", "last_seen_at", "seen_count", "expires_at" ], "properties": { "first_seen_at": { "type": "string", "format": "date-time", "example": "2026-03-01T18:22:11.000Z" }, "last_seen_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "seen_count": { "type": "integer", "minimum": 0, "example": 14 }, "expires_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" } }, "VisitorFingerprintLatestRequest": { "type": "object", "additionalProperties": false, "required": [ "user_agent", "ip_address" ], "properties": { "user_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "ip_address": { "type": "string", "example": "203.0.113.10" } }, "example": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" } }, "VisitorFingerprintStorage": { "type": "object", "additionalProperties": false, "required": [ "cookies", "local_storage", "indexed_db", "service_worker", "window_name" ], "properties": { "cookies": { "type": "boolean", "example": true }, "local_storage": { "type": "boolean", "example": true }, "indexed_db": { "type": "boolean", "example": true }, "service_worker": { "type": "boolean", "example": true }, "window_name": { "type": "boolean", "example": true } }, "example": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "VisitorFingerprintAnchors": { "type": "object", "additionalProperties": false, "required": [ "webgl_hash", "parameters_hash", "audio_hash" ], "properties": { "webgl_hash": { "type": [ "string", "null" ], "example": "123456789" }, "parameters_hash": { "type": [ "string", "null" ], "example": "-1234567890" }, "audio_hash": { "type": [ "string", "null" ], "example": "1234567890" } }, "example": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } }, "VisitorFingerprintSummary": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "lifecycle", "latest_request", "storage", "anchors" ], "properties": { "object": { "const": "visitor_fingerprint", "example": "visitor_fingerprint" }, "id": { "$ref": "#/components/schemas/FingerprintId", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "lifecycle": { "$ref": "#/components/schemas/VisitorFingerprintLifecycle", "example": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" } }, "latest_request": { "$ref": "#/components/schemas/VisitorFingerprintLatestRequest", "example": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" } }, "storage": { "$ref": "#/components/schemas/VisitorFingerprintStorage", "example": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "anchors": { "$ref": "#/components/schemas/VisitorFingerprintAnchors", "example": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } }, "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } }, "ScoreBreakdown": { "type": "object", "additionalProperties": false, "required": [ "categories" ], "properties": { "categories": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "integer", "minimum": 0, "maximum": 100, "example": 1 }, "example": { "primary": 1 } }, { "type": "null", "example": null } ], "example": { "primary": 1 } } }, "example": { "categories": { "primary": 1 } } }, "VisitorFingerprintActivitySession": { "type": "object", "additionalProperties": false, "required": [ "session_id", "decision", "request", "score_breakdown" ], "properties": { "session_id": { "$ref": "#/components/schemas/SessionId", "example": "sid_87wfetm98myh9awj0dpt28a3kc" }, "decision": { "$ref": "#/components/schemas/Decision", "example": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "request": { "$ref": "#/components/schemas/RequestContext", "example": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true } }, "score_breakdown": { "$ref": "#/components/schemas/ScoreBreakdown", "example": { "categories": { "primary": 1 } } } }, "example": { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } }, "VisitorFingerprintComponents": { "type": "object", "additionalProperties": false, "required": [ "vector" ], "properties": { "vector": { "type": "array", "items": { "type": "number", "example": 1.5 }, "example": [ 1.5 ] } }, "example": { "vector": [ 1.5 ] } }, "VisitorFingerprintActivity": { "type": "object", "additionalProperties": false, "required": [ "sessions" ], "properties": { "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorFingerprintActivitySession", "example": { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } }, "example": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } }, "example": { "sessions": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } }, "VisitorFingerprintDetail": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "lifecycle", "latest_request", "storage", "anchors", "components", "activity" ], "properties": { "object": { "const": "visitor_fingerprint", "example": "visitor_fingerprint" }, "id": { "$ref": "#/components/schemas/FingerprintId", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "lifecycle": { "$ref": "#/components/schemas/VisitorFingerprintLifecycle", "example": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" } }, "latest_request": { "$ref": "#/components/schemas/VisitorFingerprintLatestRequest", "example": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" } }, "storage": { "$ref": "#/components/schemas/VisitorFingerprintStorage", "example": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "anchors": { "$ref": "#/components/schemas/VisitorFingerprintAnchors", "example": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } }, "components": { "$ref": "#/components/schemas/VisitorFingerprintComponents", "example": { "vector": [ 1.5 ] } }, "activity": { "$ref": "#/components/schemas/VisitorFingerprintActivity", "example": { "sessions": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } } }, "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" }, "components": { "vector": [ 1.5 ] }, "activity": { "sessions": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } } }, "Slug": { "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "example": "acme-growth" }, "Organization": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "name", "slug", "status", "created_at", "updated_at" ], "properties": { "object": { "const": "organization", "example": "organization" }, "id": { "$ref": "#/components/schemas/OrganizationId", "example": "org_f6m39y94nh6fs513q03skj929c" }, "name": { "type": "string", "minLength": 1, "example": "Acme Growth Workspace" }, "slug": { "$ref": "#/components/schemas/Slug", "example": "acme-growth" }, "status": { "$ref": "#/components/schemas/OrganizationStatus", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "object": "organization", "id": "org_f6m39y94nh6fs513q03skj929c", "name": "Acme Growth Workspace", "slug": "acme-growth", "status": "active", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "ApiKey": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "type", "environment", "name", "status", "allowed_origins", "client_target", "scopes", "rate_limit", "key_preview", "last_used_at", "created_at", "rotated_at", "revoked_at", "grace_expires_at" ], "properties": { "object": { "const": "api_key", "example": "api_key" }, "id": { "$ref": "#/components/schemas/ApiKeyId", "example": "key_6cw04zdmetw8t5rsdppadhper0" }, "type": { "type": "string", "enum": [ "publishable", "secret" ], "example": "publishable" }, "environment": { "$ref": "#/components/schemas/ApiKeyEnvironment", "example": "live" }, "name": { "type": "string", "example": "Acme Growth Workspace" }, "status": { "$ref": "#/components/schemas/ApiKeyStatus", "example": "active" }, "allowed_origins": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "example": [ "https://app.acme.co/signup" ] }, { "type": "null", "example": null } ], "example": [ "https://app.acme.co/signup" ] }, "client_target": { "anyOf": [ { "$ref": "#/components/schemas/ApiKeyClientTarget" }, { "type": "null" } ], "example": "browser" }, "scopes": { "anyOf": [ { "type": "array", "items": { "type": "string", "example": "*", "enum": [ "*", "sessions:list", "sessions:read", "sessions:update", "fingerprints:list", "fingerprints:read", "organizations:create", "organizations:read", "organizations:update", "api_keys:read", "api_keys:manage", "webhooks:read", "webhooks:manage" ] }, "example": [ "*" ] }, { "type": "null", "example": null } ], "example": [ "*" ] }, "rate_limit": { "anyOf": [ { "type": "integer", "minimum": 1, "example": 1 }, { "type": "null", "example": null } ], "example": 1 }, "key_preview": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "display_key": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "revealed_key": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "rotated_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "grace_expires_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } }, "IssuedApiKey": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "type", "environment", "name", "status", "allowed_origins", "client_target", "scopes", "rate_limit", "key_preview", "last_used_at", "created_at", "rotated_at", "revoked_at", "grace_expires_at", "revealed_key" ], "properties": { "object": { "const": "api_key", "example": "api_key" }, "id": { "$ref": "#/components/schemas/ApiKeyId", "example": "key_6cw04zdmetw8t5rsdppadhper0" }, "type": { "type": "string", "enum": [ "publishable", "secret" ], "example": "publishable" }, "environment": { "$ref": "#/components/schemas/ApiKeyEnvironment", "example": "live" }, "name": { "type": "string", "example": "Acme Growth Workspace" }, "status": { "$ref": "#/components/schemas/ApiKeyStatus", "example": "active" }, "allowed_origins": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "example": [ "https://app.acme.co/signup" ] }, { "type": "null", "example": null } ], "example": [ "https://app.acme.co/signup" ] }, "client_target": { "anyOf": [ { "$ref": "#/components/schemas/ApiKeyClientTarget" }, { "type": "null" } ], "example": "browser" }, "scopes": { "anyOf": [ { "type": "array", "items": { "type": "string", "example": "*", "enum": [ "*", "sessions:list", "sessions:read", "sessions:update", "fingerprints:list", "fingerprints:read", "organizations:create", "organizations:read", "organizations:update", "api_keys:read", "api_keys:manage", "webhooks:read", "webhooks:manage" ] }, "example": [ "*" ] }, { "type": "null", "example": null } ], "example": [ "*" ] }, "rate_limit": { "anyOf": [ { "type": "integer", "minimum": 1, "example": 1 }, { "type": "null", "example": null } ], "example": 1 }, "key_preview": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "display_key": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "revealed_key": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "rotated_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "grace_expires_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } }, "CreateOrganizationRequest": { "type": "object", "additionalProperties": false, "required": [ "name", "slug" ], "properties": { "name": { "type": "string", "minLength": 1, "example": "Acme Growth Workspace" }, "slug": { "$ref": "#/components/schemas/Slug", "example": "acme-growth" } }, "example": { "name": "Acme Growth Workspace", "slug": "acme-growth" } }, "UpdateOrganizationRequest": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "name": { "type": "string", "minLength": 1, "example": "Acme Growth Workspace" }, "status": { "$ref": "#/components/schemas/OrganizationStatus", "example": "active" } }, "example": { "name": "Acme Growth Workspace", "status": "active" } }, "CreateApiKeyRequest": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "example": "Acme Growth Workspace" }, "type": { "type": "string", "enum": [ "publishable", "secret" ], "example": "publishable" }, "environment": { "$ref": "#/components/schemas/ApiKeyEnvironment", "example": "live" }, "client_target": { "$ref": "#/components/schemas/ApiKeyClientTarget", "description": "Required for native publishable keys. Defaults to browser for publishable keys and must be omitted for secret keys.", "example": "browser" }, "allowed_origins": { "type": "array", "items": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "example": [ "https://app.acme.co/signup" ] }, "scopes": { "type": "array", "items": { "type": "string", "example": "*", "enum": [ "*", "sessions:list", "sessions:read", "sessions:update", "fingerprints:list", "fingerprints:read", "organizations:create", "organizations:read", "organizations:update", "api_keys:read", "api_keys:manage", "webhooks:read", "webhooks:manage" ] }, "example": [ "*" ], "minItems": 1, "description": "Required for secret keys. Provide at least one supported secret-key scope, or [\"*\"] for all current and future scopes. Omit for publishable keys." } }, "example": { "name": "Production backend", "type": "secret", "environment": "live", "scopes": [ "sessions:read", "sessions:update", "fingerprints:read" ] }, "allOf": [ { "if": { "required": [ "scopes" ] }, "then": { "required": [ "type" ], "properties": { "type": { "const": "secret" } } } }, { "if": { "required": [ "type" ], "properties": { "type": { "const": "secret" } } }, "then": { "required": [ "scopes" ] } } ] }, "SessionResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/SessionSummary", "example": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "SessionDetailResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/SessionDetail", "example": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" }, "highlights": [ { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } ], "web_bot_auth": { "status": "verified", "domain": "browserless.io" }, "network": { "ip_address": "203.0.113.10", "ip_version": "ipv4", "status": "ready", "summary": "Browser is being driven by automation", "location": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 }, "routing": { "asn": "64512", "organization": "SPECTRANET LIMITED" }, "anonymity": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" }, "reputation": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false }, "evidence": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 }, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "runtime_integrity": { "tampering": "high_risk", "developer_tools": "high_risk", "emulation": "clean", "virtualization": "high_risk", "privacy_hardening": "notice", "identity_spoofing": "clean", "replay": "clean", "outdated_environment": "clean" }, "native_runtime_integrity": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } }, "native_app": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" }, "native_carrier": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] }, "native_motion_print": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "device_identity": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] }, "install_id": "install_id", "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } }, "connection_fingerprint": { "ja4": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, "http2": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" }, "user_agent_alignment": "match" }, "previous_decisions": [ { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } ], "request": { "url": "https://app.acme.co/signup", "referrer": "https://app.acme.co/", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "browser": { "name": "Chromium", "version": "123.0.0.0", "major_version": "123", "engine": "blink", "app_name": null }, "device": { "form_factor": "desktop", "operating_system": { "name": "macOS", "version": "123.0.0.0" }, "architecture": "arm", "screen": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" }, "locale": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] }, "capabilities": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } }, "analysis_coverage": { "browser": true, "device": true, "network": true, "runtime": true, "behavioral": true, "visitor_identity": true }, "signals_fired": [ { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } ], "client_telemetry": { "navigator": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] }, "storage": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "canvas": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true }, "graphics": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "audio": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true }, "fonts": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 }, "media": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } }, "attribution": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] }, "behavior": null } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" }, "highlights": [ { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } ], "web_bot_auth": { "status": "verified", "domain": "browserless.io" }, "network": { "ip_address": "203.0.113.10", "ip_version": "ipv4", "status": "ready", "summary": "Browser is being driven by automation", "location": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 }, "routing": { "asn": "64512", "organization": "SPECTRANET LIMITED" }, "anonymity": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" }, "reputation": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false }, "evidence": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 }, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "runtime_integrity": { "tampering": "high_risk", "developer_tools": "high_risk", "emulation": "clean", "virtualization": "high_risk", "privacy_hardening": "notice", "identity_spoofing": "clean", "replay": "clean", "outdated_environment": "clean" }, "native_runtime_integrity": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } }, "native_app": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" }, "native_carrier": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] }, "native_motion_print": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "device_identity": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] }, "install_id": "install_id", "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } }, "connection_fingerprint": { "ja4": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, "http2": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" }, "user_agent_alignment": "match" }, "previous_decisions": [ { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } ], "request": { "url": "https://app.acme.co/signup", "referrer": "https://app.acme.co/", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "browser": { "name": "Chromium", "version": "123.0.0.0", "major_version": "123", "engine": "blink", "app_name": null }, "device": { "form_factor": "desktop", "operating_system": { "name": "macOS", "version": "123.0.0.0" }, "architecture": "arm", "screen": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" }, "locale": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] }, "capabilities": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } }, "analysis_coverage": { "browser": true, "device": true, "network": true, "runtime": true, "behavioral": true, "visitor_identity": true }, "signals_fired": [ { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } ], "client_telemetry": { "navigator": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] }, "storage": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "canvas": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true }, "graphics": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "audio": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true }, "fonts": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 }, "media": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } }, "attribution": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] }, "behavior": null }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "SessionListResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "pagination", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SessionSummary", "example": { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } }, "example": [ { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } ] }, "pagination": { "$ref": "#/components/schemas/CursorPagination", "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": [ { "object": "session", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "created_at": "2026-03-24T20:00:00.000Z", "client_user_id": "user_123", "latest_decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "visitor_fingerprint": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z" } } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "VisitorFingerprintResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/VisitorFingerprintSummary", "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "VisitorFingerprintDetailResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/VisitorFingerprintDetail", "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" }, "components": { "vector": [ 1.5 ] }, "activity": { "sessions": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" }, "components": { "vector": [ 1.5 ] }, "activity": { "sessions": [ { "session_id": "sid_87wfetm98myh9awj0dpt28a3kc", "decision": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "verdict": "human", "risk_score": 94, "phase": "snapshot", "is_provisional": false, "manipulation": { "score": 1, "verdict": "none" }, "evaluation_duration_ms": 123, "evaluated_at": "2026-03-24T20:00:05.000Z" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true }, "score_breakdown": { "categories": { "primary": 1 } } } ] } }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "VisitorFingerprintListResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "pagination", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorFingerprintSummary", "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } }, "example": [ { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } ] }, "pagination": { "$ref": "#/components/schemas/CursorPagination", "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": [ { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14, "expires_at": "2026-03-24T20:00:05.000Z" }, "latest_request": { "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10" }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "anchors": { "webgl_hash": "123456789", "parameters_hash": "-1234567890", "audio_hash": "1234567890" } } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "OrganizationResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/Organization", "example": { "object": "organization", "id": "org_f6m39y94nh6fs513q03skj929c", "name": "Acme Growth Workspace", "slug": "acme-growth", "status": "active", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "organization", "id": "org_f6m39y94nh6fs513q03skj929c", "name": "Acme Growth Workspace", "slug": "acme-growth", "status": "active", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "ApiKeyResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/ApiKey", "example": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "IssuedApiKeyResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/IssuedApiKey", "example": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "ApiKeyListResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "pagination", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey", "example": { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } }, "example": [ { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } ] }, "pagination": { "$ref": "#/components/schemas/CursorPagination", "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": [ { "object": "api_key", "id": "key_6cw04zdmetw8t5rsdppadhper0", "type": "publishable", "environment": "live", "name": "Acme Growth Workspace", "status": "active", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ], "rate_limit": 1, "key_preview": "FOIL_SAMPLE_KEY", "display_key": "FOIL_SAMPLE_KEY", "revealed_key": "FOIL_SAMPLE_KEY", "last_used_at": "2026-03-24T20:00:05.000Z", "created_at": "2026-03-24T20:00:00.000Z", "rotated_at": "2026-03-24T20:00:05.000Z", "revoked_at": "2026-03-24T20:00:05.000Z", "grace_expires_at": "2026-03-24T20:00:05.000Z", "client_target": "browser" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "BrowserConfidenceSource": { "type": "string", "enum": [ "client_hints", "mixed", "user_agent" ], "example": "client_hints" }, "DeviceClass": { "type": "string", "enum": [ "desktop", "phone", "tablet", "unknown" ], "example": "desktop" }, "PointerProfile": { "type": "string", "enum": [ "fine", "coarse", "mixed", "unknown" ], "example": "fine" }, "ConsistencyStatus": { "type": "string", "enum": [ "consistent", "inconsistent", "unknown" ], "example": "consistent" }, "PlatformAuthenticatorStatus": { "type": "string", "enum": [ "available", "unavailable", "unknown" ], "example": "available" }, "SessionNetworkStatus": { "type": "string", "enum": [ "pending", "ready", "skipped", "error" ], "example": "ready" }, "SessionNetworkSkipReason": { "anyOf": [ { "type": "string", "enum": [ "missing_ip", "invalid_ip", "test_key", "loopback_ip", "private_ip", "link_local_ip", "carrier_nat_ip", "multicast_ip", "documentation_ip", "reserved_ip", "unspecified_ip", "non_global_ip" ], "example": "missing_ip" }, { "type": "null", "example": null } ], "example": "missing_ip" }, "IpVersion": { "anyOf": [ { "type": "string", "enum": [ "ipv4", "ipv6" ], "example": "ipv4" }, { "type": "null", "example": null } ], "example": "ipv4" }, "ObservationHash": { "anyOf": [ { "type": "string", "example": "obs_01234567" }, { "type": "number", "example": 1234567890 }, { "type": "null", "example": null } ], "example": "obs_01234567" }, "SessionDetailRequest": { "type": "object", "additionalProperties": false, "required": [ "url", "referrer", "user_agent" ], "properties": { "url": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "referrer": { "type": [ "string", "null" ], "example": "https://app.acme.co/" }, "user_agent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" } }, "example": { "url": "https://app.acme.co/signup", "referrer": "https://app.acme.co/", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" } }, "SessionBrowser": { "type": "object", "additionalProperties": false, "required": [ "name", "version", "major_version", "engine", "app_name" ], "properties": { "name": { "type": [ "string", "null" ], "example": "Chromium" }, "version": { "type": [ "string", "null" ], "example": "123.0.0.0" }, "major_version": { "type": [ "string", "null" ], "example": "123" }, "engine": { "type": "string", "example": "blink" }, "app_name": { "type": [ "string", "null" ], "description": "Host application when the session runs inside an embedded webview (for example \"Instagram\" or \"Facebook\"). Null for ordinary browsers.", "example": null } }, "example": { "name": "Chromium", "version": "123.0.0.0", "major_version": "123", "engine": "blink", "app_name": null } }, "SessionDeviceOperatingSystem": { "type": "object", "additionalProperties": false, "required": [ "name", "version" ], "properties": { "name": { "type": [ "string", "null" ], "example": "macOS" }, "version": { "type": [ "string", "null" ], "example": "123.0.0.0" } }, "example": { "name": "macOS", "version": "123.0.0.0" } }, "SessionDeviceScreen": { "type": "object", "additionalProperties": false, "required": [ "size", "color_depth", "pixel_ratio", "orientation_type" ], "properties": { "size": { "type": [ "string", "null" ], "example": "1440x900" }, "color_depth": { "type": [ "integer", "null" ], "minimum": 0, "example": 24 }, "pixel_ratio": { "type": [ "number", "null" ], "minimum": 0, "example": 2 }, "orientation_type": { "type": [ "string", "null" ], "example": "landscape-primary" } }, "example": { "size": "1440x900", "color_depth": 24, "pixel_ratio": 2, "orientation_type": "landscape-primary" } }, "SessionDeviceLocale": { "type": "object", "additionalProperties": false, "required": [ "timezone", "primary_language", "languages" ], "properties": { "timezone": { "type": [ "string", "null" ], "example": "America/Los_Angeles" }, "primary_language": { "type": [ "string", "null" ], "example": "en-US" }, "languages": { "type": "array", "items": { "type": "string", "example": "en-US" }, "example": [ "en-US", "en" ] } }, "example": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] } }, "SessionDeviceTouchCapabilities": { "type": "object", "additionalProperties": false, "required": [ "available", "max_touch_points" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true }, "max_touch_points": { "type": [ "integer", "null" ], "minimum": 0, "example": 0 } }, "example": { "available": true, "max_touch_points": 0 } }, "SessionDeviceStorageCapabilities": { "type": "object", "additionalProperties": false, "required": [ "cookies", "local_storage", "indexed_db", "service_worker", "window_name" ], "properties": { "cookies": { "type": [ "boolean", "null" ], "example": true }, "local_storage": { "type": [ "boolean", "null" ], "example": true }, "indexed_db": { "type": [ "boolean", "null" ], "example": true }, "service_worker": { "type": [ "boolean", "null" ], "example": true }, "window_name": { "type": [ "boolean", "null" ], "example": true } }, "example": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "SessionDeviceBooleanCapability": { "type": "object", "additionalProperties": false, "required": [ "available" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true } }, "example": { "available": true } }, "SessionDevicePlatformAuthenticatorCapabilities": { "type": "object", "additionalProperties": false, "required": [ "available", "conditional_mediation" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true }, "conditional_mediation": { "type": [ "boolean", "null" ], "example": true } }, "example": { "available": true, "conditional_mediation": true } }, "SessionDeviceCapabilities": { "type": "object", "additionalProperties": false, "required": [ "touch", "storage", "webgpu", "platform_authenticator", "media_devices", "speech_synthesis" ], "properties": { "touch": { "$ref": "#/components/schemas/SessionDeviceTouchCapabilities", "example": { "available": true, "max_touch_points": 0 } }, "storage": { "$ref": "#/components/schemas/SessionDeviceStorageCapabilities", "example": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "webgpu": { "$ref": "#/components/schemas/SessionDeviceBooleanCapability", "example": { "available": true } }, "platform_authenticator": { "$ref": "#/components/schemas/SessionDevicePlatformAuthenticatorCapabilities", "example": { "available": true, "conditional_mediation": true } }, "media_devices": { "$ref": "#/components/schemas/SessionDeviceBooleanCapability", "example": { "available": true } }, "speech_synthesis": { "$ref": "#/components/schemas/SessionDeviceBooleanCapability", "example": { "available": true } } }, "example": { "touch": { "available": true, "max_touch_points": 0 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } }, "SessionDevice": { "type": "object", "additionalProperties": false, "required": [ "form_factor", "operating_system", "architecture", "screen", "locale", "capabilities" ], "properties": { "form_factor": { "type": "string", "example": "desktop" }, "operating_system": { "type": "object", "additionalProperties": false, "required": [ "name", "version" ], "properties": { "name": { "type": [ "string", "null" ], "example": "macOS" }, "version": { "type": [ "string", "null" ], "example": "123.0.0.0" } }, "example": { "name": "macOS", "version": "123.0.0.0" } }, "architecture": { "type": [ "string", "null" ], "example": "arm" }, "screen": { "type": "object", "additionalProperties": false, "required": [ "size", "color_depth", "pixel_ratio", "orientation_type" ], "properties": { "size": { "type": [ "string", "null" ], "example": "1440x900" }, "color_depth": { "anyOf": [ { "type": "integer", "example": 1 }, { "type": "null", "example": null } ], "example": 1 }, "pixel_ratio": { "anyOf": [ { "type": "number", "example": 1.5 }, { "type": "null", "example": null } ], "example": 1.5 }, "orientation_type": { "type": [ "string", "null" ], "example": "landscape-primary" } }, "example": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" } }, "locale": { "type": "object", "additionalProperties": false, "required": [ "timezone", "primary_language", "languages" ], "properties": { "timezone": { "type": [ "string", "null" ], "example": "America/Los_Angeles" }, "primary_language": { "type": [ "string", "null" ], "example": "en-US" }, "languages": { "type": "array", "items": { "type": "string", "example": "en-US" }, "example": [ "en-US", "en" ] } }, "example": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] } }, "capabilities": { "type": "object", "additionalProperties": false, "required": [ "touch", "storage", "webgpu", "platform_authenticator", "media_devices", "speech_synthesis" ], "properties": { "touch": { "type": "object", "additionalProperties": false, "required": [ "available", "max_touch_points" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true }, "max_touch_points": { "anyOf": [ { "type": "integer", "example": 1 }, { "type": "null", "example": null } ], "example": 1 } }, "example": { "available": true, "max_touch_points": 1 } }, "storage": { "type": "object", "additionalProperties": false, "required": [ "cookies", "local_storage", "indexed_db", "service_worker", "window_name" ], "properties": { "cookies": { "type": [ "boolean", "null" ], "example": true }, "local_storage": { "type": [ "boolean", "null" ], "example": true }, "indexed_db": { "type": [ "boolean", "null" ], "example": true }, "service_worker": { "type": [ "boolean", "null" ], "example": true }, "window_name": { "type": [ "boolean", "null" ], "example": true } }, "example": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "webgpu": { "type": "object", "additionalProperties": false, "required": [ "available" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true } }, "example": { "available": true } }, "platform_authenticator": { "type": "object", "additionalProperties": false, "required": [ "available", "conditional_mediation" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true }, "conditional_mediation": { "type": [ "boolean", "null" ], "example": true } }, "example": { "available": true, "conditional_mediation": true } }, "media_devices": { "type": "object", "additionalProperties": false, "required": [ "available" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true } }, "example": { "available": true } }, "speech_synthesis": { "type": "object", "additionalProperties": false, "required": [ "available" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true } }, "example": { "available": true } } }, "example": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } } }, "example": { "form_factor": "desktop", "operating_system": { "name": "macOS", "version": "123.0.0.0" }, "architecture": "arm", "screen": { "size": "1440x900", "color_depth": 1, "pixel_ratio": 1.5, "orientation_type": "landscape-primary" }, "locale": { "timezone": "America/Los_Angeles", "primary_language": "en-US", "languages": [ "en-US", "en" ] }, "capabilities": { "touch": { "available": true, "max_touch_points": 1 }, "storage": { "cookies": true, "local_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "webgpu": { "available": true }, "platform_authenticator": { "available": true, "conditional_mediation": true }, "media_devices": { "available": true }, "speech_synthesis": { "available": true } } } }, "SessionRawDeviceNavigator": { "type": "object", "additionalProperties": false, "required": [ "model", "platform", "vendor", "hardware_concurrency", "device_memory", "max_touch_points", "pdf_viewer_enabled", "cookie_enabled", "product_sub", "primary_language", "languages", "mime_types_count", "plugins" ], "properties": { "model": { "type": [ "string", "null" ], "description": "Browser-reported device model from high-entropy User-Agent Client Hints. This identifies a model class, not a unique physical device.", "example": "Pixel 10a" }, "platform": { "type": [ "string", "null" ], "example": "macOS" }, "vendor": { "type": [ "string", "null" ], "example": "Google Inc." }, "hardware_concurrency": { "type": [ "integer", "null" ], "minimum": 0, "example": 8 }, "device_memory": { "type": [ "number", "null" ], "minimum": 0, "example": 8 }, "max_touch_points": { "type": [ "integer", "null" ], "minimum": 0, "example": 0 }, "pdf_viewer_enabled": { "type": [ "boolean", "null" ], "example": true }, "cookie_enabled": { "type": [ "boolean", "null" ], "example": true }, "product_sub": { "type": [ "string", "null" ], "example": "20030107" }, "primary_language": { "type": [ "string", "null" ], "example": "en-US" }, "languages": { "type": "array", "items": { "type": "string", "example": "en-US" }, "example": [ "en-US", "en" ] }, "mime_types_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 }, "plugins": { "type": "array", "items": { "type": "string", "example": "PDF Viewer" }, "example": [ "PDF Viewer" ] } }, "example": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] } }, "SessionRawDeviceStorage": { "type": "object", "additionalProperties": false, "required": [ "cookies", "local_storage", "session_storage", "indexed_db", "service_worker", "window_name" ], "properties": { "cookies": { "type": [ "boolean", "null" ], "example": true }, "local_storage": { "type": [ "boolean", "null" ], "example": true }, "session_storage": { "type": [ "boolean", "null" ], "example": true }, "indexed_db": { "type": [ "boolean", "null" ], "example": true }, "service_worker": { "type": [ "boolean", "null" ], "example": true }, "window_name": { "type": [ "boolean", "null" ], "example": true } }, "example": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "SessionRawDeviceCanvas": { "type": "object", "additionalProperties": false, "required": [ "hash", "geometry_hash", "text_hash", "winding", "noise_detected", "offscreen_consistent" ], "properties": { "hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "geometry_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "text_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "winding": { "type": [ "boolean", "null" ], "example": true }, "noise_detected": { "type": [ "boolean", "null" ], "example": true }, "offscreen_consistent": { "type": [ "boolean", "null" ], "example": true } }, "example": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true } }, "SessionRawDeviceGraphicsWebgl": { "type": "object", "additionalProperties": false, "required": [ "vendor", "renderer", "version", "shading_language_version", "parameters_hash", "extensions_hash", "extension_parameters_hash", "shader_precision_hash" ], "properties": { "vendor": { "type": [ "string", "null" ], "example": "Google Inc." }, "renderer": { "type": [ "string", "null" ], "example": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)" }, "version": { "type": [ "string", "null" ], "example": "WebGL 1.0" }, "shading_language_version": { "type": [ "string", "null" ], "example": "WebGL GLSL ES 1.0" }, "parameters_hash": { "$ref": "#/components/schemas/ObservationHash", "example": "01234567" }, "extensions_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "extension_parameters_hash": { "$ref": "#/components/schemas/ObservationHash", "example": "01234567" }, "shader_precision_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 } }, "example": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 } }, "SessionRawDeviceGraphicsWebgpu": { "type": "object", "additionalProperties": false, "required": [ "available", "adapter_vendor", "adapter_architecture", "fallback_adapter", "features_hash", "limits_hash" ], "properties": { "available": { "type": [ "boolean", "null" ], "example": true }, "adapter_vendor": { "type": [ "string", "null" ], "example": "Google Inc." }, "adapter_architecture": { "type": [ "string", "null" ], "example": "arm" }, "fallback_adapter": { "type": [ "boolean", "null" ], "example": true }, "features_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "limits_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 } }, "example": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "SessionRawDeviceGraphics": { "type": "object", "additionalProperties": false, "required": [ "webgl", "webgpu" ], "properties": { "webgl": { "$ref": "#/components/schemas/SessionRawDeviceGraphicsWebgl", "example": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 } }, "webgpu": { "$ref": "#/components/schemas/SessionRawDeviceGraphicsWebgpu", "example": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } } }, "example": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } } }, "SessionRawDeviceAudio": { "type": "object", "additionalProperties": false, "required": [ "hash", "sample_rate", "channel_count", "voice_count", "local_voice_count", "default_voice_lang", "noise_detected" ], "properties": { "hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1.23456e-7 }, "sample_rate": { "type": [ "number", "null" ], "minimum": 0, "example": 1.5 }, "channel_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 }, "voice_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 22 }, "local_voice_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 20 }, "default_voice_lang": { "type": [ "string", "null" ], "example": "en-US" }, "noise_detected": { "type": [ "boolean", "null" ], "example": true } }, "example": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true } }, "SessionRawDeviceFonts": { "type": "object", "additionalProperties": false, "required": [ "detected_count", "tested_count", "enumeration_hash", "metrics_hash", "preferences_hash", "emoji_hash" ], "properties": { "detected_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 }, "tested_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 }, "enumeration_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "metrics_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "preferences_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 }, "emoji_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 } }, "example": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 } }, "SessionRawDeviceMedia": { "type": "object", "additionalProperties": false, "required": [ "device_count", "counts_by_kind", "blank_label_count", "topology_hash" ], "properties": { "device_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 }, "counts_by_kind": { "type": "object", "additionalProperties": { "type": "integer", "minimum": 0, "example": 3 }, "example": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 } }, "blank_label_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 }, "topology_hash": { "$ref": "#/components/schemas/ObservationHash", "example": 1234567890 } }, "example": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } }, "SessionNetworkLocation": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "city", "region", "country", "country_code", "latitude", "longitude", "timezone", "postal_code", "accuracy_radius_km" ], "properties": { "city": { "type": [ "string", "null" ], "example": "San Francisco" }, "region": { "type": [ "string", "null" ], "example": "California" }, "country": { "type": [ "string", "null" ], "example": "United States" }, "country_code": { "type": [ "string", "null" ], "example": "US" }, "latitude": { "type": [ "number", "null" ], "example": 37.7749 }, "longitude": { "type": [ "number", "null" ], "example": -122.4194 }, "timezone": { "type": [ "string", "null" ], "example": "America/Los_Angeles" }, "postal_code": { "type": [ "string", "null" ], "example": "94103" }, "accuracy_radius_km": { "type": [ "number", "null" ], "minimum": 0, "example": 10 } }, "example": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 } }, { "type": "null", "example": null } ], "example": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 } }, "SessionNetworkAsn": { "type": "object", "additionalProperties": false, "required": [ "number", "organization" ], "properties": { "number": { "type": [ "string", "null" ], "example": "64512" }, "organization": { "type": [ "string", "null" ], "example": "SPECTRANET LIMITED" } }, "example": { "number": "64512", "organization": "SPECTRANET LIMITED" } }, "SessionNetworkPrivacy": { "type": "object", "additionalProperties": false, "required": [ "proxy", "vpn", "tor", "relay", "hosting", "residential_proxy", "callback_proxy", "suspicious_network" ], "properties": { "proxy": { "type": "boolean", "example": false }, "vpn": { "type": "boolean", "example": true }, "tor": { "type": "boolean", "example": false }, "relay": { "type": "boolean", "example": false }, "hosting": { "type": "boolean", "example": false }, "residential_proxy": { "type": "boolean", "example": false }, "callback_proxy": { "type": "boolean", "example": false }, "suspicious_network": { "type": "boolean", "example": false } }, "example": { "proxy": false, "vpn": true, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "suspicious_network": false } }, "SessionNetworkProvider": { "type": "object", "additionalProperties": false, "required": [ "organization", "anonymity_provider" ], "properties": { "organization": { "type": [ "string", "null" ], "example": "SPECTRANET LIMITED" }, "anonymity_provider": { "type": [ "string", "null" ], "example": "Mullvad VPN" } }, "example": { "organization": "SPECTRANET LIMITED", "anonymity_provider": "Mullvad VPN" } }, "SessionNetworkBlocklist": { "type": "object", "additionalProperties": false, "required": [ "listed", "categories" ], "properties": { "listed": { "type": "boolean", "example": true }, "categories": { "type": "array", "items": { "type": "string", "example": "categories" }, "example": [ "vpn" ] } }, "example": { "listed": true, "categories": [ "vpn" ] } }, "SessionNetworkClassificationMethods": { "type": "object", "additionalProperties": false, "required": [ "risk_signals", "operator_tags", "client_types", "client_count" ], "properties": { "risk_signals": { "type": "array", "items": { "type": "string", "example": "vpn" }, "example": [ "vpn" ] }, "operator_tags": { "type": "array", "items": { "type": "string", "example": "vpn" }, "example": [ "vpn" ] }, "client_types": { "type": "array", "items": { "type": "string", "example": "consumer" }, "example": [ "consumer" ] }, "client_count": { "type": [ "integer", "null" ], "minimum": 0, "example": 3 } }, "example": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 3 } }, "SessionNetwork": { "type": "object", "additionalProperties": false, "required": [ "ip_address", "ip_version", "status", "summary", "location", "routing", "anonymity", "reputation", "evidence", "evaluated_at" ], "properties": { "ip_address": { "type": [ "string", "null" ], "example": "203.0.113.10" }, "ip_version": { "anyOf": [ { "type": "string", "enum": [ "ipv4", "ipv6" ], "example": "ipv4" }, { "type": "null", "example": null } ], "example": "ipv4" }, "status": { "type": "string", "enum": [ "pending", "ready", "skipped", "error" ], "example": "ready" }, "summary": { "type": [ "string", "null" ], "example": "Browser is being driven by automation" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/SessionNetworkLocation", "example": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 } }, { "type": "null", "example": null } ], "example": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 } }, "routing": { "type": "object", "additionalProperties": false, "required": [ "asn", "organization" ], "properties": { "asn": { "type": [ "string", "null" ], "example": "64512" }, "organization": { "type": [ "string", "null" ], "example": "SPECTRANET LIMITED" } }, "example": { "asn": "64512", "organization": "SPECTRANET LIMITED" } }, "anonymity": { "type": "object", "additionalProperties": false, "required": [ "vpn", "proxy", "tor", "relay", "hosting", "residential_proxy", "callback_proxy", "provider" ], "properties": { "vpn": { "type": "boolean", "example": true }, "proxy": { "type": "boolean", "example": false }, "tor": { "type": "boolean", "example": false }, "relay": { "type": "boolean", "example": false }, "hosting": { "type": "boolean", "example": false }, "residential_proxy": { "type": "boolean", "example": false }, "callback_proxy": { "type": "boolean", "example": false }, "provider": { "type": [ "string", "null" ], "example": "Mullvad VPN" } }, "example": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" } }, "reputation": { "type": "object", "additionalProperties": false, "required": [ "listed", "categories", "suspicious_network" ], "properties": { "listed": { "type": "boolean", "example": true }, "categories": { "type": "array", "items": { "type": "string", "example": "categories" }, "example": [ "vpn" ] }, "suspicious_network": { "type": "boolean", "example": false } }, "example": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false } }, "evidence": { "type": "object", "additionalProperties": false, "required": [ "risk_signals", "operator_tags", "client_types", "client_count" ], "properties": { "risk_signals": { "type": "array", "items": { "type": "string", "example": "vpn" }, "example": [ "vpn" ] }, "operator_tags": { "type": "array", "items": { "type": "string", "example": "vpn" }, "example": [ "vpn" ] }, "client_types": { "type": "array", "items": { "type": "string", "example": "consumer" }, "example": [ "consumer" ] }, "client_count": { "anyOf": [ { "type": "integer", "minimum": 0, "example": 1 }, { "type": "null", "example": null } ], "example": 1 } }, "example": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 } }, "evaluated_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "ip_address": "203.0.113.10", "ip_version": "ipv4", "status": "ready", "summary": "Browser is being driven by automation", "location": { "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US", "latitude": 37.7749, "longitude": -122.4194, "timezone": "America/Los_Angeles", "postal_code": "94103", "accuracy_radius_km": 10 }, "routing": { "asn": "64512", "organization": "SPECTRANET LIMITED" }, "anonymity": { "vpn": true, "proxy": false, "tor": false, "relay": false, "hosting": false, "residential_proxy": false, "callback_proxy": false, "provider": "Mullvad VPN" }, "reputation": { "listed": true, "categories": [ "vpn" ], "suspicious_network": false }, "evidence": { "risk_signals": [ "vpn" ], "operator_tags": [ "vpn" ], "client_types": [ "consumer" ], "client_count": 1 }, "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "SessionRuntimeIntegrity": { "type": "object", "additionalProperties": false, "required": [ "tampering", "developer_tools", "emulation", "virtualization", "privacy_hardening", "identity_spoofing", "replay", "outdated_environment" ], "properties": { "tampering": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "high_risk" }, "developer_tools": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "high_risk" }, "emulation": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "clean" }, "virtualization": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "high_risk" }, "privacy_hardening": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "notice" }, "identity_spoofing": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "clean" }, "replay": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "clean" }, "outdated_environment": { "type": "string", "enum": [ "clean", "notice", "elevated", "high_risk" ], "example": "clean" } }, "example": { "tampering": "high_risk", "developer_tools": "high_risk", "emulation": "clean", "virtualization": "high_risk", "privacy_hardening": "notice", "identity_spoofing": "clean", "replay": "clean", "outdated_environment": "clean" } }, "SessionNativeJailbreakOrRoot": { "type": "object", "additionalProperties": false, "required": [ "detected", "signals" ], "properties": { "detected": { "type": "boolean", "example": true }, "signals": { "type": "array", "items": { "type": "string", "example": "webdriver_detected" }, "example": [ "webdriver_detected" ] }, "present_paths": { "type": "array", "items": { "type": "string", "example": "present_paths" }, "example": [ "present_paths" ] }, "dyld_insert_libraries": { "type": "array", "items": { "type": "string", "example": "dyld_insert_libraries" }, "example": [ "dyld_insert_libraries" ] }, "verified_boot_state": { "type": "string", "example": "verified_boot_state" }, "magisk_mount_present": { "type": "boolean", "example": true }, "su_on_path": { "type": "boolean", "example": true } }, "example": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true } }, "SessionNativeHooks": { "type": "object", "additionalProperties": false, "required": [ "detected" ], "properties": { "detected": { "type": "boolean", "example": true }, "frida_ports": { "type": "array", "items": { "type": "number", "example": 1.5 }, "example": [ 1.5 ] }, "frida_thread_names": { "type": "array", "items": { "type": "string", "example": "Acme Workspace" }, "example": [ "Acme Workspace" ] }, "hooked_symbols": { "type": "array", "items": { "type": "string", "example": "hooked_symbols" }, "example": [ "hooked_symbols" ] }, "self_hooked_symbols": { "type": "array", "items": { "type": "string", "example": "self_hooked_symbols" }, "example": [ "self_hooked_symbols" ] }, "prologue_anomaly_count": { "type": "number", "example": 3 }, "unexpected_dyld_images": { "type": "array", "items": { "type": "string", "example": "string" }, "example": [ "string" ] }, "xposed_packages": { "type": "array", "items": { "type": "string", "example": "xposed_packages" }, "example": [ "xposed_packages" ] } }, "example": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] } }, "SessionNativeDebugger": { "type": "object", "additionalProperties": false, "required": [ "attached" ], "properties": { "attached": { "type": "boolean", "example": true }, "tracer_pid": { "type": "number", "example": 1.5 }, "breakpoint_count": { "type": "number", "example": 3 }, "watchpoint_thread_count": { "type": "number", "example": 3 } }, "example": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 } }, "SessionNativeCodeSigning": { "type": "object", "additionalProperties": false, "required": [ "invalid" ], "properties": { "invalid": { "type": "boolean", "example": true }, "code_sign_valid": { "type": "boolean", "example": true }, "text_integrity_ok": { "type": "boolean", "example": true }, "application_debuggable": { "type": "boolean", "example": true }, "dyld_insert_libraries": { "type": "array", "items": { "type": "string", "example": "dyld_insert_libraries" }, "example": [ "dyld_insert_libraries" ] } }, "example": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] } }, "SessionNativeSimulatorOrEmulator": { "type": "object", "additionalProperties": false, "required": [ "detected" ], "properties": { "detected": { "type": "boolean", "example": true }, "is_ios_app_on_mac": { "type": "boolean", "example": true }, "qemu_files": { "type": "array", "items": { "type": "string", "example": "qemu_files" }, "example": [ "qemu_files" ] }, "ro_hardware": { "type": "string", "example": "ro_hardware" }, "ro_product_model": { "type": "string", "example": "chrome" }, "simulator_env_keys": { "type": "array", "items": { "type": "string", "example": "FOIL_SAMPLE_KEY" }, "example": [ "FOIL_SAMPLE_KEY" ] } }, "example": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] } }, "SessionNativeHardwareClaimsMismatch": { "type": "object", "additionalProperties": false, "required": [ "detected", "signals" ], "properties": { "detected": { "type": "boolean", "example": true }, "signals": { "type": "array", "items": { "type": "string", "example": "webdriver_detected" }, "example": [ "webdriver_detected" ] } }, "example": { "detected": true, "signals": [ "webdriver_detected" ] } }, "SessionNativeSimPosture": { "type": "object", "additionalProperties": false, "required": [ "detected", "signals" ], "properties": { "detected": { "type": "boolean", "example": true }, "signals": { "type": "array", "items": { "type": "string", "example": "webdriver_detected" }, "example": [ "webdriver_detected" ] } }, "example": { "detected": true, "signals": [ "webdriver_detected" ] } }, "SessionNativeAppProvenance": { "type": "object", "additionalProperties": false, "required": [ "detected", "signals" ], "properties": { "detected": { "type": "boolean", "example": true }, "signals": { "type": "array", "items": { "type": "string", "example": "webdriver_detected" }, "example": [ "webdriver_detected" ] } }, "example": { "detected": true, "signals": [ "webdriver_detected" ] } }, "SessionNativeRuntimeIntegrity": { "type": "object", "additionalProperties": false, "required": [ "platform", "jailbreak_or_root", "hooks", "debugger", "code_signing", "debug_posture", "simulator_or_emulator", "hardware_claims_mismatch", "sim_posture", "app_provenance" ], "properties": { "platform": { "type": "string", "enum": [ "ios", "android" ], "example": "ios" }, "jailbreak_or_root": { "$ref": "#/components/schemas/SessionNativeJailbreakOrRoot", "example": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true } }, "hooks": { "$ref": "#/components/schemas/SessionNativeHooks", "example": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] } }, "debugger": { "$ref": "#/components/schemas/SessionNativeDebugger", "example": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 } }, "code_signing": { "$ref": "#/components/schemas/SessionNativeCodeSigning", "example": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] } }, "simulator_or_emulator": { "$ref": "#/components/schemas/SessionNativeSimulatorOrEmulator", "example": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] } }, "hardware_claims_mismatch": { "$ref": "#/components/schemas/SessionNativeHardwareClaimsMismatch", "example": { "detected": true, "signals": [ "webdriver_detected" ] } }, "sim_posture": { "$ref": "#/components/schemas/SessionNativeSimPosture", "example": { "detected": true, "signals": [ "webdriver_detected" ] } }, "app_provenance": { "$ref": "#/components/schemas/SessionNativeAppProvenance", "example": { "detected": true, "signals": [ "webdriver_detected" ] } }, "debug_posture": { "$ref": "#/components/schemas/SessionNativeDebugPosture", "example": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } } }, "example": { "platform": "ios", "jailbreak_or_root": { "detected": true, "signals": [ "webdriver_detected" ], "present_paths": [ "present_paths" ], "dyld_insert_libraries": [ "dyld_insert_libraries" ], "verified_boot_state": "verified_boot_state", "magisk_mount_present": true, "su_on_path": true }, "hooks": { "detected": true, "frida_ports": [ 1.5 ], "frida_thread_names": [ "Acme Workspace" ], "hooked_symbols": [ "hooked_symbols" ], "self_hooked_symbols": [ "self_hooked_symbols" ], "prologue_anomaly_count": 3, "unexpected_dyld_images": [ "string" ], "xposed_packages": [ "xposed_packages" ] }, "debugger": { "attached": true, "tracer_pid": 1.5, "breakpoint_count": 3, "watchpoint_thread_count": 3 }, "code_signing": { "invalid": true, "code_sign_valid": true, "text_integrity_ok": true, "application_debuggable": true, "dyld_insert_libraries": [ "dyld_insert_libraries" ] }, "simulator_or_emulator": { "detected": true, "is_ios_app_on_mac": true, "qemu_files": [ "qemu_files" ], "ro_hardware": "ro_hardware", "ro_product_model": "chrome", "simulator_env_keys": [ "FOIL_SAMPLE_KEY" ] }, "hardware_claims_mismatch": { "detected": true, "signals": [ "webdriver_detected" ] }, "sim_posture": { "detected": true, "signals": [ "webdriver_detected" ] }, "app_provenance": { "detected": true, "signals": [ "webdriver_detected" ] }, "debug_posture": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } } }, "SessionNativeDevice": { "type": "object", "additionalProperties": false, "required": [ "platform", "os_name", "model", "manufacturer", "os_version", "os_build", "cpu_arch", "kernel_version", "boot_time_epoch_ms", "security_patch", "sdk_version" ], "properties": { "platform": { "type": "string", "enum": [ "ios", "android" ], "example": "ios" }, "model": { "type": [ "string", "null" ], "example": "model" }, "manufacturer": { "type": [ "string", "null" ], "example": "manufacturer" }, "os_name": { "type": "string", "enum": [ "iOS", "Android" ], "example": "iOS" }, "os_version": { "type": [ "string", "null" ], "example": "123.0.0.0" }, "os_build": { "type": [ "string", "null" ], "example": "os_build" }, "cpu_arch": { "type": [ "string", "null" ], "example": "arm" }, "kernel_version": { "type": [ "string", "null" ], "example": "123.0.0.0" }, "boot_time_epoch_ms": { "type": [ "number", "null" ], "example": 1.5 }, "security_patch": { "type": [ "string", "null" ], "example": "security_patch" }, "sdk_version": { "type": [ "string", "null" ], "example": "123.0.0.0" } }, "example": { "platform": "ios", "model": "model", "manufacturer": "manufacturer", "os_name": "iOS", "os_version": "123.0.0.0", "os_build": "os_build", "cpu_arch": "arm", "kernel_version": "123.0.0.0", "boot_time_epoch_ms": 1.5, "security_patch": "security_patch", "sdk_version": "123.0.0.0" } }, "SessionNativeApp": { "type": "object", "additionalProperties": false, "required": [ "bundle_id", "app_version", "app_build", "install_time_epoch_ms", "provisioning_team" ], "properties": { "bundle_id": { "type": "string", "example": "bundle_id" }, "app_version": { "type": [ "string", "null" ], "example": "123.0.0.0" }, "app_build": { "type": [ "string", "null" ], "example": "app_build" }, "install_time_epoch_ms": { "type": [ "number", "null" ], "example": 1.5 }, "provisioning_team": { "type": [ "string", "null" ], "example": "provisioning_team" } }, "example": { "bundle_id": "bundle_id", "app_version": "123.0.0.0", "app_build": "app_build", "install_time_epoch_ms": 1.5, "provisioning_team": "provisioning_team" } }, "SessionNativeCarrier": { "type": "object", "additionalProperties": false, "required": [ "platform", "carrier_name", "country_iso", "mcc", "mnc", "phone_type", "network_type", "radio_access" ], "properties": { "platform": { "type": "string", "enum": [ "ios", "android" ], "example": "ios" }, "carrier_name": { "type": [ "string", "null" ], "example": "Acme Workspace" }, "country_iso": { "type": [ "string", "null" ], "example": "United States" }, "mcc": { "type": [ "string", "null" ], "example": "mcc" }, "mnc": { "type": [ "string", "null" ], "example": "mnc" }, "phone_type": { "type": [ "string", "null" ], "example": "phone_type" }, "network_type": { "type": [ "string", "null" ], "example": "network_type" }, "radio_access": { "type": "array", "items": { "type": "string", "example": "radio_access" }, "example": [ "radio_access" ] } }, "example": { "platform": "ios", "carrier_name": "Acme Workspace", "country_iso": "United States", "mcc": "mcc", "mnc": "mnc", "phone_type": "phone_type", "network_type": "network_type", "radio_access": [ "radio_access" ] } }, "SessionNativeMotionAxes": { "type": "object", "additionalProperties": false, "required": [ "bias", "noise" ], "properties": { "bias": { "type": "array", "items": { "type": "number", "example": 1.5 }, "minItems": 3, "maxItems": 3, "example": [ 1.5, 2.5, 3.5 ] }, "noise": { "type": "array", "items": { "type": "number", "example": 1.5 }, "minItems": 3, "maxItems": 3, "example": [ 1.5, 2.5, 3.5 ] } }, "example": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "SessionDetailDeviceIdentity": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "confidence", "source", "platform", "identified_at", "lifecycle", "matched_anchors" ], "properties": { "object": { "const": "device_identity", "example": "device_identity" }, "id": { "type": "string", "example": "sid_87wfetm98myh9awj0dpt28a3kc" }, "confidence": { "type": "number", "example": 93 }, "source": { "type": "string", "enum": [ "attested", "anchored", "inferred", "new" ], "example": "attested" }, "platform": { "type": "string", "enum": [ "ios", "android" ], "example": "ios" }, "identified_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "lifecycle": { "type": "object", "additionalProperties": false, "required": [ "first_seen_at", "last_seen_at", "seen_count" ], "properties": { "first_seen_at": { "type": "string", "format": "date-time", "example": "2026-03-01T18:22:11.000Z" }, "last_seen_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "seen_count": { "type": "number", "example": 14 } }, "example": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 } }, "matched_anchors": { "type": "array", "items": { "type": "string", "example": "matched_anchors" }, "example": [ "matched_anchors" ] } }, "example": { "object": "device_identity", "id": "sid_87wfetm98myh9awj0dpt28a3kc", "confidence": 93, "source": "attested", "platform": "ios", "identified_at": "2026-03-24T20:00:05.000Z", "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 14 }, "matched_anchors": [ "matched_anchors" ] } }, "SessionNativeMotionPrint": { "type": "object", "additionalProperties": false, "required": [ "platform", "sample_count", "gyro", "accel", "mag" ], "properties": { "platform": { "type": "string", "enum": [ "ios", "android" ], "example": "ios" }, "sample_count": { "type": "number", "example": 3 }, "gyro": { "$ref": "#/components/schemas/SessionNativeMotionAxes", "example": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "accel": { "$ref": "#/components/schemas/SessionNativeMotionAxes", "example": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, "mag": { "anyOf": [ { "$ref": "#/components/schemas/SessionNativeMotionAxes", "example": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } }, { "type": "null", "example": null } ], "example": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } } }, "example": { "platform": "ios", "sample_count": 3, "gyro": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "accel": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] }, "mag": { "bias": [ 1.5, 2.5, 3.5 ], "noise": [ 1.5, 2.5, 3.5 ] } } }, "SessionDetailDecision": { "type": "object", "additionalProperties": false, "required": [ "event_id", "automation_status", "risk_score", "evaluation_phase", "decision_status", "evaluated_at" ], "properties": { "event_id": { "$ref": "#/components/schemas/EventId", "example": "evt_srwqc0yqhz4bxvtrdtf69q7vkr" }, "automation_status": { "type": "string", "enum": [ "automated", "human", "uncertain" ], "example": "automated" }, "risk_score": { "type": "integer", "minimum": 0, "maximum": 100, "example": 94 }, "evaluation_phase": { "anyOf": [ { "$ref": "#/components/schemas/Phase", "example": "snapshot" }, { "type": "null", "example": null } ], "example": "snapshot" }, "decision_status": { "type": "string", "enum": [ "preliminary", "final" ], "example": "preliminary" }, "evaluated_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "event_id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "automation_status": "automated", "risk_score": 94, "evaluation_phase": "snapshot", "decision_status": "preliminary", "evaluated_at": "2026-03-24T20:00:05.000Z" } }, "SessionHighlightEvidence": { "type": "object", "additionalProperties": false, "required": [ "signal", "name" ], "properties": { "signal": { "type": "string", "examples": [ "webdriver_detected" ] }, "name": { "type": "string", "examples": [ "WebDriver detected" ] } }, "example": { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } }, "SessionHighlight": { "type": "object", "additionalProperties": false, "required": [ "key", "effect", "importance", "summary" ], "properties": { "key": { "type": "string", "example": "browser_automation" }, "effect": { "type": "string", "enum": [ "increases_risk", "reduces_risk", "context" ], "example": "increases_risk" }, "importance": { "type": "string", "enum": [ "high", "medium", "low" ], "example": "high" }, "summary": { "type": "string", "example": "Browser is being driven by automation" }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/SessionHighlightEvidence", "example": { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } }, "example": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } }, "example": { "key": "browser_automation", "effect": "increases_risk", "importance": "high", "summary": "Browser is being driven by automation", "evidence": [ { "signal": "webdriver_detected", "name": "Acme Growth Workspace" } ] } }, "SessionWebBotAuth": { "type": "object", "additionalProperties": false, "required": [ "status", "domain" ], "properties": { "status": { "type": [ "string", "null" ], "example": "verified" }, "domain": { "type": [ "string", "null" ], "example": "browserless.io" } }, "example": { "status": "verified", "domain": "browserless.io" } }, "SessionDetailVisitorFingerprintLifecycle": { "type": "object", "additionalProperties": false, "required": [ "first_seen_at", "last_seen_at", "seen_count" ], "properties": { "first_seen_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-01T18:22:11.000Z" }, "last_seen_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "seen_count": { "anyOf": [ { "type": "integer", "minimum": 0, "example": 1 }, { "type": "null", "example": null } ], "example": 1 } }, "example": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } }, "SessionDetailVisitorFingerprint": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "confidence", "identified_at", "resolution", "lifecycle" ], "properties": { "object": { "const": "visitor_fingerprint", "example": "visitor_fingerprint" }, "id": { "$ref": "#/components/schemas/FingerprintId", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "confidence": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100, "example": 1 }, { "type": "null", "example": null } ], "example": 1 }, "identified_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" }, "resolution": { "type": "object", "additionalProperties": false, "description": "How this session was tied to the visitor ID.", "required": [ "method", "basis" ], "properties": { "method": { "type": [ "string", "null" ], "enum": [ "continuity", "fingerprint", "fingerprint_evolution", "new", "native_persistent", "native_new", "existing", "unknown", null ], "description": "The evidence that resolved this session to the visitor ID. Null when the session predates resolution tracking.", "example": "continuity" }, "basis": { "type": [ "string", "null" ], "enum": [ "deterministic", "probabilistic", null ], "description": "Deterministic means an exact identifier saved in an earlier session (continuity token or device anchor). Probabilistic means a statistical fingerprint match. Null for new visitors.", "example": "deterministic" } }, "example": { "method": "continuity", "basis": "deterministic" } }, "lifecycle": { "$ref": "#/components/schemas/SessionDetailVisitorFingerprintLifecycle", "example": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } } }, "example": { "object": "visitor_fingerprint", "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m", "confidence": 1, "identified_at": "2026-03-24T20:00:05.000Z", "resolution": { "method": "continuity", "basis": "deterministic" }, "lifecycle": { "first_seen_at": "2026-03-01T18:22:11.000Z", "last_seen_at": "2026-03-24T20:00:05.000Z", "seen_count": 1 } } }, "SessionConnectionFingerprint": { "type": "object", "additionalProperties": false, "required": [ "ja4", "http2", "user_agent_alignment" ], "properties": { "ja4": { "type": "object", "additionalProperties": false, "required": [ "hash", "profile", "family", "product", "confidence", "match_source", "reference", "deterministic" ], "properties": { "hash": { "type": [ "string", "null" ], "example": "t13d1516h2_0123456789ab_fedcba987654" }, "profile": { "type": [ "string", "null" ], "example": "chrome" }, "family": { "type": [ "string", "null" ], "example": "chromium" }, "product": { "type": [ "string", "null" ], "example": "chrome" }, "confidence": { "type": [ "string", "null" ], "example": "exact" }, "match_source": { "type": [ "string", "null" ], "example": "full_ja4" }, "deterministic": { "type": [ "boolean", "null" ], "example": true }, "reference": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "label", "source", "protocol", "tls_version", "sni", "alpn", "cipher_count", "ext_count", "sample_size", "verified" ], "properties": { "label": { "type": "string", "example": "Chrome" }, "source": { "type": "string", "example": "master_db" }, "protocol": { "type": "string", "example": "t" }, "tls_version": { "type": "string", "example": "13" }, "sni": { "type": "string", "example": "d" }, "alpn": { "type": "string", "example": "h2" }, "cipher_count": { "type": "object", "additionalProperties": false, "required": [ "min", "max" ], "properties": { "min": { "type": "integer", "example": 15 }, "max": { "type": "integer", "example": 16 } }, "example": { "min": 15, "max": 16 } }, "ext_count": { "type": "object", "additionalProperties": false, "required": [ "min", "max" ], "properties": { "min": { "type": "integer", "example": 15 }, "max": { "type": "integer", "example": 16 } }, "example": { "min": 15, "max": 16 } }, "sample_size": { "type": "integer", "example": 63 }, "verified": { "type": [ "boolean", "null" ], "example": true } }, "example": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, { "type": "null", "example": null } ], "example": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } } }, "example": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } } }, "http2": { "type": "object", "additionalProperties": false, "required": [ "akamai_fingerprint", "profile" ], "properties": { "akamai_fingerprint": { "type": [ "string", "null" ], "example": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s" }, "profile": { "type": [ "string", "null" ], "example": "chrome" } }, "example": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" } }, "user_agent_alignment": { "anyOf": [ { "type": "string", "enum": [ "match", "mismatch", "unknown" ], "example": "match" }, { "type": "null", "example": null } ], "example": "match" } }, "example": { "ja4": { "hash": "t13d1516h2_0123456789ab_fedcba987654", "profile": "chrome", "family": "chromium", "product": "chrome", "confidence": "exact", "match_source": "full_ja4", "deterministic": true, "reference": { "label": "Chrome", "source": "master_db", "protocol": "t", "tls_version": "13", "sni": "d", "alpn": "h2", "cipher_count": { "min": 15, "max": 16 }, "ext_count": { "min": 15, "max": 16 }, "sample_size": 63, "verified": true } }, "http2": { "akamai_fingerprint": "1:65536;4:131072;5:16384|12517377|0|m,p,a,s", "profile": "chrome" }, "user_agent_alignment": "match" } }, "SessionAnalysisCoverage": { "type": "object", "additionalProperties": false, "required": [ "browser", "device", "network", "runtime", "behavioral", "visitor_identity" ], "properties": { "browser": { "type": "boolean", "example": true }, "device": { "type": "boolean", "example": true }, "network": { "type": "boolean", "example": true }, "runtime": { "type": "boolean", "example": true }, "behavioral": { "type": "boolean", "example": true }, "visitor_identity": { "type": "boolean", "example": true } }, "example": { "browser": true, "device": true, "network": true, "runtime": true, "behavioral": true, "visitor_identity": true } }, "SessionSignalFired": { "type": "object", "additionalProperties": false, "required": [ "signal", "role", "category", "strength", "signal_score" ], "properties": { "signal": { "type": "string", "examples": [ "webdriver_detected" ] }, "role": { "type": "string", "example": "owner" }, "category": { "type": "string", "example": "environment" }, "strength": { "type": "string", "example": "definitive" }, "signal_score": { "type": "integer", "minimum": 0, "maximum": 100, "example": 100 } }, "example": { "signal": "webdriver_detected", "role": "owner", "category": "environment", "strength": "definitive", "signal_score": 100 } }, "SessionClientTelemetry": { "type": "object", "additionalProperties": false, "description": "Curated lower-level client telemetry grouped for investigation and analysis.", "required": [ "navigator", "storage", "canvas", "graphics", "audio", "fonts", "media" ], "properties": { "navigator": { "$ref": "#/components/schemas/SessionRawDeviceNavigator", "example": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] } }, "storage": { "$ref": "#/components/schemas/SessionRawDeviceStorage", "example": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true } }, "canvas": { "$ref": "#/components/schemas/SessionRawDeviceCanvas", "example": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true } }, "graphics": { "$ref": "#/components/schemas/SessionRawDeviceGraphics", "example": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } } }, "audio": { "$ref": "#/components/schemas/SessionRawDeviceAudio", "example": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true } }, "fonts": { "$ref": "#/components/schemas/SessionRawDeviceFonts", "example": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 } }, "media": { "$ref": "#/components/schemas/SessionRawDeviceMedia", "example": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } } }, "example": { "navigator": { "model": null, "platform": "macOS", "vendor": "Google Inc.", "hardware_concurrency": 8, "device_memory": 8, "max_touch_points": 0, "pdf_viewer_enabled": true, "cookie_enabled": true, "product_sub": "20030107", "primary_language": "en-US", "languages": [ "en-US", "en" ], "mime_types_count": 3, "plugins": [ "PDF Viewer" ] }, "storage": { "cookies": true, "local_storage": true, "session_storage": true, "indexed_db": true, "service_worker": true, "window_name": true }, "canvas": { "hash": 1234567890, "geometry_hash": 1234567890, "text_hash": 1234567890, "winding": true, "noise_detected": true, "offscreen_consistent": true }, "graphics": { "webgl": { "vendor": "Google Inc.", "renderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M2, Unspecified Version)", "version": "WebGL 1.0", "shading_language_version": "WebGL GLSL ES 1.0", "parameters_hash": "01234567", "extensions_hash": 1234567890, "extension_parameters_hash": "01234567", "shader_precision_hash": 1234567890 }, "webgpu": { "available": true, "adapter_vendor": "Google Inc.", "adapter_architecture": "arm", "fallback_adapter": true, "features_hash": 1234567890, "limits_hash": 1234567890 } }, "audio": { "hash": 1.23456e-7, "sample_rate": 1.5, "channel_count": 3, "voice_count": 22, "local_voice_count": 20, "default_voice_lang": "en-US", "noise_detected": true }, "fonts": { "detected_count": 3, "tested_count": 3, "enumeration_hash": 1234567890, "metrics_hash": 1234567890, "preferences_hash": 1234567890, "emoji_hash": 1234567890 }, "media": { "device_count": 3, "counts_by_kind": { "audioinput": 1, "audiooutput": 1, "videoinput": 1 }, "blank_label_count": 3, "topology_hash": 1234567890 } } }, "UpdateApiKeyRequest": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "name": { "type": "string", "example": "Acme Growth Workspace" }, "allowed_origins": { "type": "array", "items": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "example": [ "https://app.acme.co/signup" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "*", "sessions:list", "sessions:read", "sessions:update", "fingerprints:list", "fingerprints:read", "organizations:create", "organizations:read", "organizations:update", "api_keys:read", "api_keys:manage", "webhooks:read", "webhooks:manage" ], "example": "*" }, "example": [ "*" ], "minItems": 1, "description": "When updating a secret key, provide at least one supported secret-key scope, or [\"*\"] for all current and future scopes." } }, "example": { "name": "Acme Growth Workspace", "allowed_origins": [ "https://app.acme.co/signup" ], "scopes": [ "*" ] } }, "WebhookEndpointId": { "type": "string", "pattern": "^we_[0-9a-f]{32}$", "example": "we_0123456789abcdef0123456789abcdef" }, "WebhookEventId": { "type": "string", "pattern": "^wevt_[0-9a-f]{32}$", "example": "wevt_0123456789abcdef0123456789abcdef" }, "WebhookDeliveryId": { "type": "string", "pattern": "^wdlv_[0-9a-f]{32}$", "example": "wdlv_0123456789abcdef0123456789abcdef" }, "WebhookEventType": { "type": "string", "enum": [ "session.result.persisted" ], "example": "session.result.persisted" }, "WebhookDeliveryEventType": { "type": "string", "enum": [ "session.result.persisted", "webhook.test" ], "example": "session.result.persisted" }, "WebhookEndpointStatus": { "type": "string", "enum": [ "active", "disabled" ], "example": "active" }, "WebhookDeliveryStatus": { "type": "string", "enum": [ "pending", "delivering", "succeeded", "failed", "skipped" ], "example": "pending" }, "WebhookEndpoint": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "name", "url", "status", "event_types", "created_at", "updated_at" ], "properties": { "object": { "type": "string", "const": "webhook_endpoint", "example": "webhook_endpoint" }, "id": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" }, "name": { "type": "string", "example": "Acme Growth Workspace" }, "url": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "status": { "$ref": "#/components/schemas/WebhookEndpointStatus", "example": "active" }, "event_types": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventType", "example": "session.result.persisted" }, "example": [ "session.result.persisted" ] }, "signing_secret": { "type": "string", "description": "Returned only when the endpoint is created or its secret is rotated.", "example": "whsec_0123456789abcdef0123456789abcdef" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "CreateWebhookEndpointRequest": { "type": "object", "additionalProperties": false, "required": [ "name", "url", "event_types" ], "properties": { "name": { "type": "string", "minLength": 1, "example": "Acme Growth Workspace" }, "url": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "event_types": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/WebhookEventType", "example": "session.result.persisted" }, "example": [ "session.result.persisted" ] } }, "example": { "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "event_types": [ "session.result.persisted" ] } }, "UpdateWebhookEndpointRequest": { "type": "object", "additionalProperties": false, "description": "Partial webhook endpoint update. Updating event_types replaces the endpoint subscriptions.", "properties": { "name": { "type": "string", "minLength": 1, "example": "Acme Growth Workspace" }, "url": { "type": "string", "format": "uri", "example": "https://app.acme.co/signup" }, "status": { "$ref": "#/components/schemas/WebhookEndpointStatus", "example": "active" }, "event_types": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/WebhookEventType", "example": "session.result.persisted" }, "example": [ "session.result.persisted" ] } }, "example": { "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ] } }, "WebhookEndpointResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/WebhookEndpoint", "example": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "WebhookEndpointListResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "pagination", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpoint", "example": { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "example": [ { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ] }, "pagination": { "$ref": "#/components/schemas/CursorPagination", "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": [ { "object": "webhook_endpoint", "id": "we_0123456789abcdef0123456789abcdef", "name": "Acme Growth Workspace", "url": "https://app.acme.co/signup", "status": "active", "event_types": [ "session.result.persisted" ], "signing_secret": "whsec_0123456789abcdef0123456789abcdef", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "EventSubject": { "type": "object", "additionalProperties": false, "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "type" }, "id": { "type": "string", "example": "sid_87wfetm98myh9awj0dpt28a3kc" } }, "example": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" } }, "Event": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "type", "subject", "data", "webhook_deliveries", "created_at" ], "properties": { "object": { "type": "string", "const": "event", "example": "event" }, "id": { "$ref": "#/components/schemas/WebhookEventId", "example": "wevt_0123456789abcdef0123456789abcdef" }, "type": { "$ref": "#/components/schemas/WebhookDeliveryEventType", "example": "session.result.persisted" }, "subject": { "$ref": "#/components/schemas/EventSubject", "example": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" } }, "data": { "type": "object", "additionalProperties": true, "example": { "source": "signup_form" } }, "webhook_deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDelivery", "example": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "example": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ] }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" } }, "example": { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" } }, "EventResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/Event", "example": { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "EventListResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "pagination", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event", "example": { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" } }, "example": [ { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" } ] }, "pagination": { "$ref": "#/components/schemas/CursorPagination", "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": [ { "object": "event", "id": "wevt_0123456789abcdef0123456789abcdef", "type": "session.result.persisted", "subject": { "type": "type", "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "data": { "source": "signup_form" }, "webhook_deliveries": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "created_at": "2026-03-24T20:00:00.000Z" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "WebhookDelivery": { "type": "object", "additionalProperties": false, "required": [ "object", "id", "event_id", "endpoint_id", "event_type", "status", "attempts", "response_status", "response_body", "error", "created_at", "updated_at" ], "properties": { "object": { "type": "string", "const": "webhook_delivery", "example": "webhook_delivery" }, "id": { "$ref": "#/components/schemas/WebhookDeliveryId", "example": "wdlv_0123456789abcdef0123456789abcdef" }, "event_id": { "$ref": "#/components/schemas/WebhookEventId", "example": "wevt_0123456789abcdef0123456789abcdef" }, "endpoint_id": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" }, "event_type": { "$ref": "#/components/schemas/WebhookDeliveryEventType", "example": "session.result.persisted" }, "status": { "$ref": "#/components/schemas/WebhookDeliveryStatus", "example": "pending" }, "attempts": { "type": "integer", "minimum": 0, "example": 1 }, "response_status": { "type": [ "integer", "null" ], "example": 1 }, "response_body": { "type": [ "string", "null" ], "example": "response_body" }, "error": { "type": [ "string", "null" ], "example": "error" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "WebhookDeliveryListResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "pagination", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDelivery", "example": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "example": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ] }, "pagination": { "$ref": "#/components/schemas/CursorPagination", "example": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": [ { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } ], "pagination": { "limit": 50, "has_more": false, "next_cursor": "eyJ2IjoxLCJzY29yZWRBdCI6IjIwMjYtMDQtMTBUMDY6NDI6NDIuNTE0WiIsInJvd0lkIjoiMTc3In0" }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "WebhookTest": { "type": "object", "additionalProperties": false, "required": [ "object", "event_id", "delivery_ids", "latest_delivery" ], "properties": { "object": { "type": "string", "const": "webhook_test", "example": "webhook_test" }, "event_id": { "$ref": "#/components/schemas/WebhookEventId", "example": "wevt_0123456789abcdef0123456789abcdef" }, "delivery_ids": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryId", "example": "wdlv_0123456789abcdef0123456789abcdef" }, "example": [ "wdlv_0123456789abcdef0123456789abcdef" ] }, "latest_delivery": { "anyOf": [ { "$ref": "#/components/schemas/WebhookDelivery", "example": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, { "type": "null", "example": null } ], "example": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } } }, "example": { "object": "webhook_test", "event_id": "wevt_0123456789abcdef0123456789abcdef", "delivery_ids": [ "wdlv_0123456789abcdef0123456789abcdef" ], "latest_delivery": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } } }, "WebhookTestResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/WebhookTest", "example": { "object": "webhook_test", "event_id": "wevt_0123456789abcdef0123456789abcdef", "delivery_ids": [ "wdlv_0123456789abcdef0123456789abcdef" ], "latest_delivery": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } } }, "meta": { "$ref": "#/components/schemas/ResponseMeta", "example": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "example": { "data": { "object": "webhook_test", "event_id": "wevt_0123456789abcdef0123456789abcdef", "delivery_ids": [ "wdlv_0123456789abcdef0123456789abcdef" ], "latest_delivery": { "object": "webhook_delivery", "id": "wdlv_0123456789abcdef0123456789abcdef", "event_id": "wevt_0123456789abcdef0123456789abcdef", "endpoint_id": "we_0123456789abcdef0123456789abcdef", "event_type": "session.result.persisted", "status": "pending", "attempts": 1, "response_status": 1, "response_body": "response_body", "error": "error", "created_at": "2026-03-24T20:00:00.000Z", "updated_at": "2026-03-24T20:00:05.000Z" } }, "meta": { "request_id": "req_cf147349a4134208aebb8c70e25fb7e1" } } }, "WebhookRequestSummary": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": [ "string", "null" ], "format": "uri", "example": "https://app.acme.co/signup" }, "user_agent": { "type": [ "string", "null" ], "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36" }, "ip_address": { "type": [ "string", "null" ], "example": "203.0.113.10" }, "screen_size": { "type": [ "string", "null" ], "example": "1440x900" }, "is_touch_capable": { "type": "boolean", "example": true }, "platform": { "type": [ "string", "null" ], "example": "macOS" }, "first_seen": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-01T18:22:11.000Z" }, "risk_time": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" } }, "SessionResultPersistedPayload": { "type": "object", "additionalProperties": false, "required": [ "object", "session", "event", "decision", "visitor_fingerprint", "request", "score_breakdown", "signals", "attribution" ], "properties": { "object": { "type": "string", "const": "session_result", "example": "session_result" }, "session": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/SessionId", "example": "sid_87wfetm98myh9awj0dpt28a3kc" } }, "example": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" } }, "event": { "type": "object", "additionalProperties": false, "required": [ "id", "scoring_event_id", "phase", "is_provisional", "persisted_at" ], "properties": { "id": { "$ref": "#/components/schemas/EventId", "example": "evt_srwqc0yqhz4bxvtrdtf69q7vkr" }, "scoring_event_id": { "type": "string", "example": "scoring_event_id" }, "phase": { "type": [ "string", "null" ], "example": "phase" }, "is_provisional": { "type": [ "boolean", "null" ], "example": false }, "persisted_at": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:05.000Z" } }, "example": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" } }, "decision": { "type": "object", "additionalProperties": false, "required": [ "verdict", "risk_score", "score", "manipulation" ], "properties": { "verdict": { "$ref": "#/components/schemas/Verdict", "example": "human" }, "risk_score": { "type": "integer", "minimum": 0, "maximum": 100, "example": 94 }, "score": { "type": "number", "minimum": 0, "maximum": 1, "example": 0.08 }, "manipulation": { "anyOf": [ { "$ref": "#/components/schemas/ManipulationSummary", "example": { "score": 1, "verdict": "none" } }, { "type": "null", "example": null } ], "example": { "score": 1, "verdict": "none" } } }, "example": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } } }, "visitor_fingerprint": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/FingerprintId", "example": "vid_7cyvmdfjs3rzznf8m65v3bv51m" } }, "example": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" } }, { "type": "null", "example": null } ], "example": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" } }, "request": { "$ref": "#/components/schemas/WebhookRequestSummary", "example": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" } }, "score_breakdown": { "type": "object", "additionalProperties": true, "required": [ "categories" ], "properties": { "categories": { "type": "object", "additionalProperties": true, "example": { "source": "signup_form" } } }, "example": { "categories": { "source": "signup_form" } } }, "signals": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "sid_87wfetm98myh9awj0dpt28a3kc" }, "category": { "type": "string", "example": "environment" }, "confidence": { "type": "string", "example": "exact" }, "score": { "type": "number", "example": 0.08 }, "role": { "type": "string", "example": "owner" } }, "example": { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } }, "example": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ] }, "attribution": { "type": "object", "additionalProperties": true, "properties": { "bot": { "type": [ "object", "null" ], "additionalProperties": true, "example": { "source": "signup_form" } } }, "example": { "bot": { "source": "signup_form" } } } }, "example": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } }, "WebhookTestEventPayload": { "type": "object", "additionalProperties": true, "required": [ "object", "endpoint" ], "properties": { "object": { "type": "string", "const": "webhook_test", "example": "webhook_test" }, "endpoint": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEndpointId", "example": "we_0123456789abcdef0123456789abcdef" } }, "example": { "id": "we_0123456789abcdef0123456789abcdef" } } }, "example": { "object": "webhook_test", "endpoint": { "id": "we_0123456789abcdef0123456789abcdef" } } }, "WebhookEventEnvelope": { "type": "object", "additionalProperties": false, "required": [ "id", "object", "type", "created", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId", "example": "wevt_0123456789abcdef0123456789abcdef" }, "object": { "type": "string", "const": "webhook_event", "example": "webhook_event" }, "type": { "$ref": "#/components/schemas/WebhookDeliveryEventType", "example": "session.result.persisted" }, "created": { "type": "string", "format": "date-time", "example": "2026-03-24T20:00:00.000Z" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SessionResultPersistedPayload", "example": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } }, { "$ref": "#/components/schemas/WebhookTestEventPayload", "example": { "object": "webhook_test", "endpoint": { "id": "we_0123456789abcdef0123456789abcdef" } } } ], "example": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } } }, "example": { "id": "wevt_0123456789abcdef0123456789abcdef", "object": "webhook_event", "type": "session.result.persisted", "created": "2026-03-24T20:00:00.000Z", "data": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } } }, "SessionResultPersistedWebhookEvent": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventEnvelope", "example": { "id": "wevt_0123456789abcdef0123456789abcdef", "object": "webhook_event", "type": "session.result.persisted", "created": "2026-03-24T20:00:00.000Z", "data": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } } } ], "type": "object", "properties": { "type": { "type": "string", "const": "session.result.persisted", "example": "session.result.persisted" }, "data": { "$ref": "#/components/schemas/SessionResultPersistedPayload", "example": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } } }, "example": { "id": "wevt_0123456789abcdef0123456789abcdef", "object": "webhook_event", "type": "session.result.persisted", "created": "2026-03-24T20:00:00.000Z", "data": { "object": "session_result", "session": { "id": "sid_87wfetm98myh9awj0dpt28a3kc" }, "event": { "id": "evt_srwqc0yqhz4bxvtrdtf69q7vkr", "scoring_event_id": "scoring_event_id", "phase": "phase", "is_provisional": false, "persisted_at": "2026-03-24T20:00:05.000Z" }, "decision": { "verdict": "human", "risk_score": 94, "score": 0.08, "manipulation": { "score": 1, "verdict": "none" } }, "visitor_fingerprint": { "id": "vid_7cyvmdfjs3rzznf8m65v3bv51m" }, "request": { "url": "https://app.acme.co/signup", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "ip_address": "203.0.113.10", "screen_size": "1440x900", "is_touch_capable": true, "platform": "macOS", "first_seen": "2026-03-01T18:22:11.000Z", "risk_time": "2026-03-24T20:00:05.000Z" }, "score_breakdown": { "categories": { "source": "signup_form" } }, "signals": [ { "id": "sid_87wfetm98myh9awj0dpt28a3kc", "category": "environment", "confidence": "exact", "score": 0.08, "role": "owner" } ], "attribution": { "bot": { "source": "signup_form" } } } } }, "SessionNativeDebugPosture": { "type": "object", "additionalProperties": false, "required": [ "detected", "risk_signals" ], "properties": { "detected": { "type": "boolean", "example": true }, "adb_enabled": { "type": "boolean", "example": true }, "developer_options_enabled": { "type": "boolean", "example": true }, "app_debuggable": { "type": "boolean", "example": true }, "app_profileable": { "type": "boolean", "example": true }, "app_test_only": { "type": "boolean", "example": true }, "debugger_attached": { "type": "boolean", "example": true }, "get_task_allow": { "type": "boolean", "example": true }, "embedded_provisioning_profile_present": { "type": "boolean", "example": true }, "receipt_is_sandbox": { "type": "boolean", "example": true }, "receipt_is_testflight": { "type": "boolean", "example": true }, "development_bundle": { "type": "boolean", "example": true }, "active_debugger_attached": { "type": "boolean", "example": true }, "breakpoint_count": { "type": "number", "example": 3 }, "exception_port_count": { "type": "number", "example": 3 }, "watchpoint_thread_count": { "type": "number", "example": 3 }, "tracer_pid": { "type": "number", "example": 1.5 }, "direct_syscall_tracer_pid": { "type": "number", "example": 1.5 }, "risk_signals": { "type": "array", "items": { "type": "string", "example": "vpn" }, "example": [ "vpn" ] } }, "example": { "detected": true, "adb_enabled": true, "developer_options_enabled": true, "app_debuggable": true, "app_profileable": true, "app_test_only": true, "debugger_attached": true, "get_task_allow": true, "embedded_provisioning_profile_present": true, "receipt_is_sandbox": true, "receipt_is_testflight": true, "development_bundle": true, "active_debugger_attached": true, "breakpoint_count": 3, "exception_port_count": 3, "watchpoint_thread_count": 3, "tracer_pid": 1.5, "direct_syscall_tracer_pid": 1.5, "risk_signals": [ "vpn" ] } }, "SessionAttributionLabel": { "type": "object", "additionalProperties": false, "required": [ "kind", "value", "label", "confidence" ], "properties": { "kind": { "type": "string", "enum": [ "actor", "provider", "tool", "product", "organization", "purpose", "environment", "trust", "evasion" ], "example": "actor" }, "value": { "type": "string", "example": "automation" }, "label": { "type": "string", "example": "Automation" }, "confidence": { "type": "integer", "minimum": 0, "maximum": 100, "example": 98 } }, "example": { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 } }, "SessionAttributionBehavior": { "type": "object", "additionalProperties": false, "required": [ "channel", "value", "label", "confidence" ], "properties": { "channel": { "type": "string", "enum": [ "typing", "form", "mouse", "touch", "scroll", "clipboard" ], "example": "typing" }, "value": { "type": "string", "example": "synthetic-typing" }, "label": { "type": "string", "example": "Synthetic Typing" }, "confidence": { "type": "integer", "minimum": 0, "maximum": 100, "example": 86 } }, "example": { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } }, "SessionAttribution": { "type": "object", "additionalProperties": false, "required": [ "labels", "behaviors" ], "properties": { "labels": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttributionLabel" }, "example": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ] }, "behaviors": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttributionBehavior" }, "example": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] } }, "example": { "labels": [ { "kind": "actor", "value": "automation", "label": "Automation", "confidence": 98 }, { "kind": "tool", "value": "selenium", "label": "Selenium", "confidence": 88 } ], "behaviors": [ { "channel": "typing", "value": "synthetic-typing", "label": "Synthetic Typing", "confidence": 86 } ] } }, "UpdateSessionRequest": { "type": "object", "additionalProperties": false, "required": [ "client_user_id" ], "properties": { "client_user_id": { "type": [ "string", "null" ], "maxLength": 256, "description": "Customer-supplied identifier for the end user associated with this Foil session. Set with PATCH /v1/sessions/{sessionId}.", "example": "user_123" } }, "example": { "client_user_id": "user_123" } } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Send Authorization: Bearer ." } } }, "webhooks": { "session.result.persisted": { "post": { "tags": [ "Webhooks" ], "operationId": "sessionResultPersistedWebhook", "summary": "Session result persisted webhook", "description": "Foil sends a signed unified webhook envelope. Verify X-Foil-Timestamp and X-Foil-Signature against the raw request body using the endpoint signing secret.", "parameters": [ { "name": "X-Foil-Timestamp", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Unix timestamp used in the webhook signature base string." }, { "name": "X-Foil-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 signature computed over `${timestamp}.${rawBody}`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResultPersistedWebhookEvent" } } } }, "responses": { "200": { "description": "Webhook accepted." }, "400": { "description": "Invalid payload." }, "401": { "description": "Invalid signature." }, "500": { "description": "Internal error." } } } } } }