MobileKeyRequest

object
device_idstringrequired

Stable identifier for the guest’s device.

<= 128 characters

platformstringrequired

Allowed values:iosandroid

guest_namestring | null

Shown on the key, e.g. for a second guest in the room.

<= 100 characters

Example

MobileKey

object
idstring

Example:key_7Hq2mX

device_idstring
platformstring

Allowed values:iosandroid

guest_namestring | null
room_numberstring

Example:1412

statusstring

Allowed values:activerevokedexpired

valid_fromstring(date-time)
valid_untilstring(date-time)
Example

MobileKeyWithCredential

idstring

Example:key_7Hq2mX

device_idstring
platformstring

Allowed values:iosandroid

guest_namestring | null
room_numberstring

Example:1412

statusstring

Allowed values:activerevokedexpired

valid_fromstring(date-time)
valid_untilstring(date-time)
credentialstringrequired

Opaque payload for the lock vendor SDK. Returned once, at issue time.

Example

ServiceCategory

string

Allowed values:housekeepingamenitiesmaintenanceconcierge

ServiceRequestStatus

string

Allowed values:openin_progresscompletedcancelled