Skip to main content

Activate a smart credential

PUT 
/api/web/v1/smartcredentials/:id/activate

Activate the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the smart credential to be activated.

Body

required

    additionalUserInfo

    object

    A map which consists of additional attributes and values to be used for smart credential encoding. Currently the only value that is supported is the value with name "photo" where the value is a Base-64 encoded JPEG or PNG image or a data URL of the form "data:image/<type>;base64,<data>" where <type> is jpeg or png and <data> is a Base-64 encoded JPEG or PNG image.

    property name* string

    A map which consists of additional attributes and values to be used for smart credential encoding. Currently the only value that is supported is the value with name "photo" where the value is a Base-64 encoded JPEG or PNG image or a data URL of the form "data:image/;base64,<data>" where is jpeg or png and <data> is a Base-64 encoded JPEG or PNG image.

    deliverActivationEmail boolean

    A flag indicating if the activation email should be delivered to the user. If not set, it defaults to false.

    mobile boolean

    A flag indicating if the target is mobile smart credential.

    requirePassword string[]

    Possible values: [LINK, QRCODE]

    A list of which activation types (LINK or QRCODE) should use a random password to encrypt the activation information. If the list is null or empty, QRCODE activation will require a password and LINK will not.

    type string[]

    Possible values: [LINK, QRCODE]

    A list of activation types (LINK or QRCODE) to perform. If the list is null or empty, all activation types are performed

Responses​

Successful

Schema

    activationPassword string

    If either the QR Code URL or the Link URL were password protected, the password needed to unprotect them.

    linkHttpURL string

    The HTTP version of the link activation URL

    linkURL string

    The link activation URL

    qrCode string

    Base-64 encoded activation QR Code

    qrCodeURL string

    The activation URL encoded into the QR Code

Loading...