SSI Interaction Page

Interaction is an act of data exchange between parties, often with specific requirements that need to be satisfied before or after the interaction occurs. These requirements may involve meeting certain criteria, providing specific data or credentials, or fulfilling other requirements for a successful initiation of the interaction. The result of a successful interaction can involve activities such as data transfer, issuance of new credentials, granting or denying access to a resource with login restrictions, and more.

 

Features

Description

Screenshots

Features

Description

Screenshots

Create new Interaction

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

Screen Shot 2024-02-02 at 15.59.22-20240202-140006.png

 

Interaction Info Tab

 

 

Interaction ID

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

On the mobile app, interactions will be displayed in ascending chronological order starting from the earliest created 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 in the app.

To change the status of an interaction, go to the "Interactions" page and select the desired status from the “Status“ drop-down list.

Screen Shot 2024-02-02 at 16.01.38-20240202-140230.png

 

Name Interaction

 

 

Name the interaction in the “Name” field. This name will be shown as the title of this interaction’s button on your service’s page in the ProofSpace mobile app.
We recommend following the naming rule of capitalizing the first letter of each word, e.g.: My Interaction Name.

Interactions are automatically saved after naming. While you can edit a saved interaction, please note that deletion is not possible.

Once the interaction is saved, 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/2289008812 section.

 

 

Describe Interaction

Provide a short description of the interaction for your clients. This text will be displayed at the top of the interaction’s screen in the ProofSpace mobile app.

Add an icon for the Interaction

You can add an icon that may represent the purpose of this interaction for your clients. This icon will be displayed alongside the interaction's name in the ProofSpace app.

You can upload a custom image by clicking the "Upload" button and selecting the file. Alternatively, you can choose from default icons in the "Select default" drop-down list. The chosen icon will also be visible on the dashboard page of this interaction.

Notification flow

You can configure the notification flow for users of the ProofSpace mobile app. These notifications will appear as pop-up messages to your clients, providing information about different stages of the interaction.

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

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

If the interaction was initiated, the client submitted the required credentials (if they exist), but the interaction hasn't been completed for any reason yet, the message from the "Pending" section will be shown.

Text from the "Failure" section will appear in the mobile app if there is an issue with data transfer, verification, or any other reason preventing the interaction from being completed.

 

Details Tab

 

 

Initiation Media

(Select source for initiating your Interaction)

 

 

 

 

 

 

 

 

 

There are several ways to initiate an interaction.

QR Code Initiation:

  • 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), and the code will dynamically update.

  • See the “QR Codes“ section of this page for the information on how to find the interaction’s QR code.

Button Initiation:

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.

Incoming Push from Service:

  • If you select the “Incoming push from service,” the Interaction will be initiated by the dashboard operator or through the “Credential Issue Webhook“.

  • Note that choosing this initiation method restricts certain features: you can't edit the Issue Credentials template, create multiple instances, and the concurrency type will be set to "Concurrent." If you already had multiple instances in this interaction, the interaction will use the first instance automatically.

 

Concurrency type

Choose a concurrency type for the current interaction:

Once:

  • Select the "Once" checkbox if the interaction can be initiated and executed by the same client with the same DID only once.

Sequenced:

  • Select the "Sequenced" checkbox if the interaction can 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.

Concurrent:

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

 

No-logging events

 

 

 

 

 

 

 

 

 

 

 

 

 

 

By default, you have access to all the interaction’s data on 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.

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

The fact that this interaction has been executed 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 on the service dashboard only the credentials received or only issued credentials in this interaction.

 

 

 

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 it.

 

Web hook (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.

 

Instances tab

 

 

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.

 

Extensions tab (Integration options)

An extension is a set of webhooks that provide extended functionality for your service to interact with external systems.

Please follow this link for more information.

 

 

 

 

Edit interaction

 

 

 

 

 

To edit the interaction, navigate to the "Interactions" tab in the main menu. Click on the interaction's name, and proceed to make any necessary updates. All changes will be automatically saved instantly.

 

 

QR Codes

To find the QR code for this interaction, click on the name of the interaction on the "Interactions" page. Then, on the right top corner of the next page, click on the “QR codes and deeplinks“ button. The QR code will be opened on the new tab.