Profile

Get device information (Profile Authorization)

Returns the device information for a profile. Requires a valid <b>Profile</b> token in the authorization header.

get/api/v1/profile/deviceInformation

Request

  • Base URL
    https://api.sahha.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Response

Returns device information for the profile specified by the token in the authorization header.

sdkIdstring

Sahha SDK identifier (based on customer integration). E.G. 'android_kotlin', 'ios_swift', 'react_native', 'flutter', 'capacitor', 'cordova'.

sdkVersionstring

Sahha SDK version string such as 3.4.1.

appIdstring

Sahha customer's App Bundle Id, e.g. com.sahha.app.

appVersionstring nullable

Sahha customer's App Version, e.g. 0.1.4

deviceIdstring uuid nullable

The identifier for the device.

deviceTypestring

User device identifier such as 'Apple iPhone' or 'Samsung Galaxy'.

deviceModelstring

User device model identifier such as 'iPhone X' or 'Galaxy S10'.

systemstring

User device platform such as 'iOS', 'iPadOS', 'Android'.

systemVersionstring

User device platform version such as '15.1' on iOS or '21' on Android.

timeZonestring nullable

Time Zone of the profile holder. +12:00

Example response

{
  "sdkId": "ios_swift",
  "sdkVersion": "3.4.1",
  "appId": "com.sahha.app",
  "appVersion": "0.1.4",
  "deviceId": "C85330AD-C691-453C-8CB6-353AB75FD611",
  "deviceType": "iPhone",
  "deviceModel": "iPhone X",
  "system": "iOS",
  "systemVersion": "15.1",
  "timeZone": "+12:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.