Docs › API reference › Device verification

User agent lookup

Looks up details for a user agent string.

POSThttps://api.screenlyyid.com/api/v1/ua-lookup-verify

Headers#

Name	Type	Required	Description
`x-api-key`	string	Yes	Your ScreenlyyID API key
`x-correlation-id`	string (uuid)	No	Correlation ID for this customer check

Request body#

Field	Type	Required
`UserAgent`	string	No
`UserAgentVersion`	string	No
`UserAgentFlatform`	string	No
`UserAgentFlatformVersion`	string	No
`UserAgentMobile`	string	No
`DeviceModel`	string	No
`DeviceBrand`	string	No

Responses#

Status	Description
`200`	Successful response

Response body (200)#

Field	Type	Required
`DeviceModel`	string	No
`Os`	string	No
`DeviceBrand`	string	No
`BrowserRelease`	string	No
`OsFamily`	string	No
`DevicePixelRatio`	integer (int64)	Yes
`DeviceHeightPx`	integer (int64)	Yes
`Ua`	string	No
`Type`	string	No
`DevicePpi`	integer (int64)	Yes
`DevicePrice`	integer (int64)	Yes
`Version`	string	No
`VersionMajor`	string	No
`OsVersionMajor`	string	No
`BrowserEngine`	string	No
`DeviceModelCode`	string	No
`OsVersion`	string	No
`DeviceRelease`	string	No
`Name`	string	No
`IsWebview`	boolean	Yes
`DeviceResolution`	string	No
`DeviceWidthPx`	integer (int64)	Yes
`IsMobile`	boolean	Yes

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/ua-lookup-verify' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "UserAgent": "<UserAgent>",
  "UserAgentVersion": "<UserAgentVersion>",
  "UserAgentFlatform": "<UserAgentFlatform>",
  "UserAgentFlatformVersion": "<UserAgentFlatformVersion>",
  "UserAgentMobile": "<UserAgentMobile>",
  "DeviceModel": "<DeviceModel>",
  "DeviceBrand": "<DeviceBrand>"
}'

const body = {
  "UserAgent": "<UserAgent>",
  "UserAgentVersion": "<UserAgentVersion>",
  "UserAgentFlatform": "<UserAgentFlatform>",
  "UserAgentFlatformVersion": "<UserAgentFlatformVersion>",
  "UserAgentMobile": "<UserAgentMobile>",
  "DeviceModel": "<DeviceModel>",
  "DeviceBrand": "<DeviceBrand>"
};

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/ua-lookup-verify",
  {
    "method": "POST",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "x-correlation-id": "YOUR_CORRELATION_ID",
      "Content-Type": "application/json"
    },
    "body": JSON.stringify(body)
  }
);

const result = await response.json();

import requests

payload = {
    "UserAgent": "<UserAgent>",
    "UserAgentVersion": "<UserAgentVersion>",
    "UserAgentFlatform": "<UserAgentFlatform>",
    "UserAgentFlatformVersion": "<UserAgentFlatformVersion>",
    "UserAgentMobile": "<UserAgentMobile>",
    "DeviceModel": "<DeviceModel>",
    "DeviceBrand": "<DeviceBrand>"
}

response = requests.post(
    'https://api.screenlyyid.com/api/v1/ua-lookup-verify',
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-correlation-id": "YOUR_CORRELATION_ID"
    },
    json=payload
)
result = response.json()

using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
var json = @"{
  ""UserAgent"": ""<UserAgent>"",
  ""UserAgentVersion"": ""<UserAgentVersion>"",
  ""UserAgentFlatform"": ""<UserAgentFlatform>"",
  ""UserAgentFlatformVersion"": ""<UserAgentFlatformVersion>"",
  ""UserAgentMobile"": ""<UserAgentMobile>"",
  ""DeviceModel"": ""<DeviceModel>"",
  ""DeviceBrand"": ""<DeviceBrand>""
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.screenlyyid.com/api/v1/ua-lookup-verify", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();