Mobile Credential-Related Properties

Learn about credential properties that you should use when creating mobile credentials.

When issuing a guest mobile credential, you can use the following relevant properties:

acs_credential Properties

These properties are applicable to guest credentials for the Visionline ACS.

Property	Type	Description
is_multi_phone_sync_credential	Boolean	Indicates whether the credential is a multi-phone sync credential . When creating a Seam mobile key for a Visionline ACS, you must set this property to true.
allowed_acs_entrance_ids	Array of strings Optional	List of ACS entrance IDs to which you want to grant the specified ACS user access.
starts_at	ISO 8601 format	Starting timestamp for credential activation.
ends_at	ISO 8601 format	Ending timestamp for credential expiration.

---

acs_credential.visionline_metadata Properties

Use the credential.visionline_metadata object to include brand-specific data for your Visionline credentials.

Property	Type	Description
card_function_type	Enum	guest
cardFormat	Enum	rfid48 | TLCode rfid48: A low-capacity card. It can store up to 33 consecutive guest rooms, 28 common rooms, and 7 additional rooms. TLCode: A high capacity RFID card (for card types needing more than 48 bytes). For guest cards, generally use rfid48. For guest advanced cards, which need a higher capacity format, use TLCode.
label	String	“Label” field data for mobile credentials. This field may contain plain text, as well as predefined placeholders. The placeholders are surrounded by percent signs (%). See Label Placeholders .
override	Boolean	Indicates whether this guest credential invalidates any previously-issued credentials for overlapping entrances. Applicable only to guest credentials.
joiner_acs_credential_ids	Array of strings Optional	List of credential IDs with which the current guest credential shares entrance access. When override_previous_credentials is false, joiner_acs_credential_ids becomes a mandatory field. Applicable only to guest credentials.
assa_abloy_credential_service_mobile_endpoint_id	String	ID of the ASSA ABLOY Credential Service mobile endpoint associated with the credential.
is_valid	Boolean	Indicates whether the credential is currently valid.

---

Label Placeholders

The label field provides “label” field data for mobile credentials. This field may contain plain text, as well as predefined placeholders. The placeholders are surrounded by percent signs (%). Visionline replaces these placeholders with the actual values before issuing mobile keys. The final text is truncated to 32 characters. The valid placeholders are as follows:

• %ROOMNUM%: Replaced with main guest room number or name.
• %ROOMLIST%: Replaced with comma-separated list of guest rooms.
• %ROOMRANGE%: Replaced with hyphen-separated room range. Alternately, if some rooms do not fit into any range, then they are added as a comma-separated list.
• %SITENAME%: Name of the property.
• %CARDNUM%: Credential ID.
• %UUID%: BLE UUID.
• %USERID%: Value passed in the UI field.