Skip to main content

SmartCredential

Information returned from the service about a smart credential.

Properties

NameTypeDescriptionNotes
AllowedActionsList<SmartCredential.AllowedActionsEnum>A list of administration actions currently allowed for this smart credential.[optional]
CardDigitalConfigDigitalIdConfig[optional]
CardDigitalConfigIdstringThe UUID of the Card Digital Id config of this smart credential. If not set, the smart credential will not have a Card Digital Id.[optional]
CardDigitalConfigRequiredbool?Indicates if the card digitalid config is required or not.[optional]
CardHolderDigitalConfigDigitalIdConfig[optional]
CardHolderDigitalConfigIdstringThe UUID of the Card Holder Digital Id config of this smart credential. If not set, the smart credential will not have a Card Holder Digital Id.[optional]
CardHolderDigitalConfigRequiredbool?Indicates if the card holder digitalid config is required or not.[optional]
CertificatesList<DigitalIdCert>A list of certificates associated with this smart credential.[optional]
ChipIdstringThe chip id of the smart card set when the smart credential is encoded.[optional]
DigitalIdsList<DigitalId>A list of digital ids associated with this smart credential.[optional]
EncodeMsgstringFor smart credentials that have failed to encode, the encode message stores a message providing information about the failure.[optional]
EncodeStatestringThe encode state of a smart credential indicates if encoding has started, completed successfully or failed.[optional]
EnrollStatestringThe enrollment state of a smart credential indicates if all of the necessary enrollment values have been collected. Only smart credentials in the ENROLLED state can be activated.[optional]
ExpiryDateDateTime?For issued smart credentials, the expiry date is the date on which the smart credential will expire.[optional]
IdstringThe unique UUID assigned to the smart credential when it is created.[optional]
IssueDateDateTime?The date on which the smart credential was issued.[optional]
NotifyEnabledbool?A flag indicating if notification is enabled for this smart credential.[optional]
PlatformstringThe platform of the Mobile SC application on which this smart credential was encoded.[optional]
ScDefnIdstringThe UUID of the Smart Credential Definition that defines this smart credential.[optional]
ScDefnNamestringThe name of the smart credential definition of this smart credential.[optional]
SerialNumberstringThe unique serial number of the smart credential generated when it is created.[optional]
StatestringThe state of the smart credential. Only smart credentials in the ACTIVE state can be used for authentication.[optional]
UserIdstringThe UUID of the user that owns this smart credential.[optional]
UserUserIdstringThe user Id of the user that owns this smart credential.[optional]
VariableValuesList<SCVariableValue>Variable values for this smart credential[optional]
VarVersionstringThe version of the Mobile SC application on which this smart credential was encoded.[optional]