v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB

Interview

Fetch device info list

Fetch all device information entries associated with the given onboarding Session.

get/omni/b2b/v1/devices/info

Query parameters

idstring required

Represents Session id for which device data are requested.

Headers

api-versionstring required

Response

ipAddressstring

IP address of the device from which onboarding is being executed.

hashstring

Hash is generated out of data specific to user device and browser: userAgent, webdriver, language, colorDepth, deviceMemory, hardwareConcurrency, screenResolution, availableScreenResolution, timezoneOffset, timezone, sessionStorage, localStorage, indexedDb, cpuClass, platform, plugins, canvas, webgl, webglVendorAndRenderer, adBlock, hasLiedLanguages, hasLiedResolution, hasLiedOs, hasLiedBrowser, touchSupport, fonts, audio.

deviceType'IOS' | 'ANDROID' | 'WEBAPP'

Device type

osVersionstring

deviceModelstring

sdkVersionstring

browserstring

hasLiedBrowserboolean

longitudenumber float

User's geolocation longitude.

latitudenumber float

User's geolocation latitude.

locationstring

User's location at the moment of onboarding process.

getmAdminAreastring

State

getmSubAdminAreastring

County

getmLocalitystring

City

getmSubLocalitystring

Neighborhood, common name

getmThoroughfarestring

Street name.

getmSubThoroughfarestring

Number.

getmPostalCodestring

Zip code

getmCountryCodestring

Country code

getmCountryNamestring

Country name

hostingAppstring

Hosting App

Example response

[
  {
    "getmAdminArea": "CA",
    "getmSubAdminArea": "Santa Clara",
    "getmSubLocality": "Mission District",
    "getmCountryCode": "US",
    "getmCountryName": "United States",
    "hostingApp": "Onboarding"
  }
]