SSI Interaction Page

Create new Interaction

To create a new interaction, navigate to the "Interaction" tab in the main menu and click the "Add Interaction" button.

Name Interaction

Name the interaction in the “Name” field. This name will be shown as the title of this interaction’s button on the mobile application service screen.
We recommend following the naming rule of capitalizing the first letter of each word, e.g.: My Interaction Name.
Once you have saved the interaction, you can add localization for the interaction name and description. For more information about localization, see the platform documentation https://proofspace.atlassian.net/wiki/spaces/PSM/pages/2077327369 section.

Describe Interaction

The 'Description' field can be used to provide a description of the interaction. This text will be displayed at the top of the interaction screen in the mobile app.

Add an icon for the Interaction

The icon that will be displayed for this interaction in the mobile app may be uploaded from an external source by clicking the “Upload” button and then selecting the desired file; or by selecting an icon from the “Select default” drop-down list.

The selected icon will also be shown on the dashboard page of this interaction.

Interaction mode

(Active/Paused)

Interactions can have two statuses: “Active” and “Paused”.

Only interactions with an "Active" status are visible to mobile app users. Paused interactions do not appear on the app.

To change the status of an interaction, go to the "Interactions" page.

Interaction ID

The interaction ID number will be assigned to the interaction automatically in the order in which the interactions are created.

On the mobile app, interactions will be displayed in ascending chronological order starting from the earliest created Interaction.

Select source for initiating an Interaction

There are several ways to initiate an interaction.

If you select the “QR” checkbox, the mobile user will initiate the interaction by scanning a QR-code. You can set the QR code's timeout (in seconds), after which it will be dynamically updated.

To find a QR code of the specific interaction, click the “Interactions“ tab of the main menu. On the new page, click the “QR codes and deeplinks” button, and select the interaction’s name.

If your select the “Button” checkbox, the mobile app user will initiate the interaction by clicking the “Proceed” button on this Interaction’s screen in the app.

If you select the “Incoming push from service,” the Interaction will be initiated by the dashboard operator.

Note that if you select the initiation media “Incoming push from service”, the Issue Credentials template will not be edited because these credentials are created before the interaction starts and the user shares their credentials.

No-logging event

By default, you have access to all the interaction’s data from your service's dashboard.

For privacy reasons, you may choose not to store information about credentials received from a user, credentials issued to a user, or interaction information in general. At the same time, unsaved in your service dashboard issued credentials will still be valid and possible for verification, including by your service.

If the whole interaction’s data should be deleted after the completion of the interaction, clear the "Save Interaction Event" checkbox in the interaction settings.

The fact that you executed this interaction will be visible on your dashboard for another 24 hours.

After the interaction is complete, the system will automatically delete all the data associated with the issued credentials.

The system will also delete all the personal data related to the required credentials obtained from the user in this interaction. Still, a list of these credentials names will remain viewable for 24 hours following the completion of this interaction.

Please note that if in this interaction you request previously obtained from this user service-attested credential, and it’s data hasn't been changed since, all data of this credential will be visible in this interaction's info pop-up window within 24 hours.

Select or clear the appropriate checkboxes if you want to store only the credentials received or only issued due to this interaction in the service dashboard.

Required and Issued Credentials

Select required and Issued credentials in the appropriate fields.

See the "Required and issued credentials" page for more information about configuring the required and issued credentials.

Flow notifications

The flow notifications for the mobile application client can be configured in the "Flow notifications" section. During the interaction, these messages will be displayed to the user of the mobile application in the form of pop-ups.

If an interaction has instances, you can specify the name of the instance's parameter in the flow notifications. For example, if the instance parameter's name is "Room Number," the "Success" message can be "Welcome to Room {{Room Number}}!" In this case, the pop-up message for the mobile app user (a guest of room number 2) will be "Welcome to Room 2!"

If the interaction is completed successfully, the message from the "Success" section will appear as a pop-up in the mobile application.

The message from the "Pending" section will appear in the mobile application if the client successfully submitted the required credentials, but the interaction has not yet been completed.

Text from the"Failure" section will appear in the mobile app if the system is unable to transfer or verify data, or the current interaction cannot be performed for any reason.

Concurrency type

Choose a concurrency type.

Select the "Once" checkbox if the current interaction can be initiated and executed by the same client with the same DID one time only.

Select the "Sequenced" checkbox if the interaction may be executed multiple times by the same client with the same DID, but only after the current interaction has been executed and has a "Complete" status on the dashboard.

Select the "Concurrent" checkbox if the current interaction may be initiated simultaneously by the same client with the same DID.

Integration options

To integrate with third party systems, you can add a webhook or extension(s) to the interaction.

Please follow this link for more information.

Parameters and Instances

You can add parameters and instances to the interaction.

For more detailed information about how to add and use parameters and instances in your interactions, please refer to this link.

Save interaction

You cannot delete saved interactions.

Once you have added all the necessary details to the interaction, click "Done" to save it.

Edit interaction

To edit the interaction, click on the "Interactions" tab in the main menu. Click the “Edit” button next to the chosen interaction. Edit the interaction. Click "Done."

Interactions can have two modes: "Active" and "Paused". Paused interactions are not visible on the mobile application’s "Service" screen.

To edit a previously saved interaction, please follow these steps:

1. Click on the "Interactions" tab in the main menu.

2. Click on the "Edit" button next to the interaction you want to edit.

3. Make the necessary changes to the interaction.

4. Click "Done" to save the changes.

Please note that once an interaction has been saved, it cannot be deleted.

QR Codes

The list of QR embedded code template for interaction instances with initiation media "QR" and deep links to call interaction from third-party app can be found on the "Interactions" page by clicking the "QR codes and deeplinks" button.