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
acs_credential
PropertiesThese properties are applicable to guest credentials for the Visionline ACS.
Property | Type | Description |
---|---|---|
| Boolean Optional | 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 |
| Array of strings | List of ACS entrance IDs to which you want to grant the specified ACS user access. |
| ISO 8601 format Optional | Starting timestamp for credential activation. |
| ISO 8601 format Optional | Ending timestamp for credential expiration. |
acs_credential.visionline_metadata
Properties
acs_credential.visionline_metadata
PropertiesUse the credential.visionline_metadata
object to include brand-specific data for your Visionline credentials.
Property | Type | Description |
---|---|---|
| Enum Optional |
|
| Enum Required |
For guest cards, generally use For guest advanced cards, which need a higher capacity format, use |
| 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 ( |
| Boolean Optional | Indicates whether this guest credential invalidates any previously-issued credentials for overlapping entrances. Applicable only to guest credentials. |
| Array of strings Optional | List of credential IDs with which the current guest credential shares entrance access. When |
| String Optional | ID of the ASSA ABLOY Credential Service mobile endpoint associated with the credential. |
| Boolean Optional | 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.
Last updated