fingerprint
/
Start a new fingerprint

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description
public.json
public.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/public/
Production API server
https://api.fluid.app/
Local development server
https://api.fluid.test/

Orders

Operations

carts

Operations

checkout

Operations

events

Operations

lead

Operations

page

Operations

fingerprint

Operations

Start a new fingerprint

Request

Bodyapplication/json
fingerprintobject(Fingerprint)required
fingerprint.​user_agentstring
Example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.192 Safari/537.36"
fingerprint.​languagestring
Example: "en-US"
fingerprint.​platformstring
Example: "MacIntel"
fingerprint.​hardware_concurrencynumber or string
Example: 8
fingerprint.​color_depthnumber or string
Example: 24
fingerprint.​screen_resolutionstring
Example: "1920x1080"
fingerprint.​time_zonestring
Example: "Europe/London"
fingerprint.​session_storageboolean
Example: true
fingerprint.​local_storageboolean
Example: true
fingerprint.​indexed_dbboolean
Example: true
fingerprint.​do_not_trackboolean
Example: false
fingerprint.​cookies_enabledboolean
Example: true
fingerprint.​canvasstring
Example: 0
fingerprint.​webglobject
fingerprint.​installed_fontsArray of strings
Example: ["Helvetica"]
fingerprint.​pluginsstring
Example: "Chrome PDF Plugin"
fingerprint.​touch_supportobject
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​attributionAttributionLookupEmail (object) or AttributionLookupUsername (object) or AttributionLookupSharedGuid (object) or AttributionLookupFluidRepId (object) or AttributionLookupExternalId (object)(AttributionLookup)
Any of:
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/browser/fingerprint \
  -H 'Content-Type: application/json' \
  -d '{
    "fingerprint": {
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.192 Safari/537.36",
      "language": "en-US",
      "platform": "MacIntel",
      "hardware_concurrency": 8,
      "color_depth": 24,
      "screen_resolution": "1920x1080",
      "time_zone": "Europe/London",
      "session_storage": true,
      "local_storage": true,
      "indexed_db": true,
      "do_not_track": false,
      "cookies_enabled": true,
      "canvas": 0,
      "webgl": {
        "vendor": "Google Inc.",
        "renderer": "ANGLE (Intel(R) UHD Graphics 630 Direct3D11 vs_5_0 ps_5_0)",
        "version": "WebGL 1.0"
      },
      "installed_fonts": [
        "Helvetica"
      ],
      "plugins": "Chrome PDF Plugin",
      "touch_support": {
        "max_touch_points": 10,
        "touch_event": true,
        "touch_points": 10
      }
    },
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

fingerprint created

Bodyapplication/json
statusnumberrequired
Example: 201
metadataobject(ResponseMetadata)required
Example: {"fluid_shop":"myshop","fluid_session":"fs_szwdDuRbqEe7AV7sXk7vVq","request_uuid":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-01-01T00:00:00Z"}
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstringrequired
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​request_uuidstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
metadata.​timestampstringrequired
Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "status": 201,
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

session

Operations