Device

Information that describes a user’s device.

Field

Data Type

Description

deviceId

string

Required

A unique id assigned to the device on your lending app. For example, a UUID.

Limited to 50 characters.

Read-only after creation

deviceType

string (

'mobile_phone',

'personal_computer'

)

Required

The type of device.

Read-only after creation

modelNumber

string

Required A unique code or name assigned by a manufacturer that identifies the device's model. This will usually be found on the device's operating system and is accessible programmatically.

Read-only after creation

osName

string

(

'android',

'ios',

'windows',

'unix',

'other'

)

Required Device operating system name.

Read-only after creation

createdAt

string

( Timestamp format )

Required The date the device was created in ISO format.

Example: 2019-05-12T12:00:55+03:00

Read-only after creation

active

boolean

Required Denotes whether the device is in use by the user or deactivated (e.g because of a change in devices).

Read-write

equipmentId

string | null

Device’s equipment identifier. For example, an IMEI number in the case of mobile phones, or a serial number for personal computers. Defaults to null.

Read-only after creation

otherEquipmentId

string | null

Other equipment identifiers associated with this device. For example, a secondary IMEI in the case of dual SIM mobile phones. Defaults to null.

Read-only after creation

osVersion

string | null

Operating system version. Defaults to null.

Read-write

primaryImei

string

Deprecated A mobile phone’s primary IMEI number. This field is deprecated, use equipmentId instead.

Read-only after creation

otherImei

string

Deprecated

A secondary IMEI associated with a mobile phone. For example, in dual SIM mobile handsets.

This field is deprecated, use otherEquipmentId instead.

Read-only after creation

serialNumber

string | null

Deprecated Device’s serial number. This field is deprecated, use equipmentId instead.

Read-only after creation

Last updated