Integration options

The ProofSpace platform offers a broad range of integration options, such as deep and web links, data and status exchange via a webhook, and configuration of webhook sets, which we call extensions. It also provides the ability to perform additional data verification on a third-party system and issue credentials by calling https://proofspace.atlassian.net/wiki/spaces/PSM/pages/2133786630.

Features

Description

Screenshots

External verification hook

If the required credential definition includes an "External verification hook," you can enable extra external verification by selecting the "Use external verification" checkbox.
This feature serves as an additional layer of verification that a third-party system performs. For the credential to be considered verified, the verification result from this third-party system must be positive.
In other words, verification will be possible only if both of the following conditions are met:

  • The requested verifiable credentials are verified successfully, and

  • The verification result from the third-party system is "true."

Integrate with ProofSpace platform services via Deep and App links.

 

 

 

 

 

 

 

 

 

 

Pre-filling credential data from QR code

The ProofSpace mobile application provides functionality to handle calls from third-party mobile applications via Deeplinks (Mobile deep linking) and Web Links (call the native application from a web page). 

Both options can initiate the ProofSpace app to execute a specified interaction and pre-fill the attributes of self-attested credentials (if needed).

The ProofSpace app also supports callbacks to the requesting side after successfully executing these interactions.

To find an example of QR-code format that can be embed on your website to enable the initialisation of particular interaction, go to the "Interactions" page and click the "QR codes" button. Then, select the desired interaction's name and click "Embed" on the new window.

To set up an interaction that can be initiated from a third-party service via Deep or Web link, select "QR code" as the initiation media for the interaction (1). 

Then, choose the self-attested credential that needs to be pre-filled from the QR code (2).

Then, click on the chosen required credential (3) and select the "Pre-fill from QR" checkbox in the "Edit required credential" pop-up window.

Note that attribute data pre-filled in this way (via the QR code) will not be editable in the app.

You can find more information on how to integrate third-party applications and websites with ProofSpace services through App and Deep links here.

 

Extension(s)

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

 

 

 

Install extension

First step is to install an extension to your service. If the extension has already been installed, you can add this extension to the interaction.

To install a new extension to your service, follow these steps:

  1. Navigate to the "Extensions" tab in the main menu.

  2. Click "Install extension."

  3. Select the "Public Extensions" or "My Extensions" tab on the pop-up window and install the desired extension.

Add extension to the interaction

On the “Edit interaction“ page, click “Select“ next to the “Extension Setup“ field.

On the “Extension Settings” pop-up window, click “Add“ next to desired extension. If the selected extension requires additional settings, you will see the corresponding fields to fill out.

Add all the required information in the appropriate fields and click “Submit.“

If this extension requires credentials, for example DID of the integrated SSI platform, it will be added automatically to this interaction.

 

Configure the chosen

Extension

Click on the “Configure extension“ icon next to the chosen extension.

On the "Configure extension "pop-up window, set the credential issuance conditions from the drop-down menu: "Any," "Schema," or "Credential Definition."

By default, it will be "Any."
If you select "Schema "or "Credential Definition, an extension will be triggered to issue credentials only based on the selected schema or credential definition respectively.

Web hook URL

Setting up a webhook allows you to send the client's data from this interaction to a third-party system (such as a CRM).

To do so:

  1. Click on the “Web hook“ field. The “Edit web hook“ pop-up window will appear.

  2. Enter the URL of the endpoint that will receive the webhook request.

  3. Select the key. By default, this webhook will use the default service key that was automatically generated when we approved your service. This key will be used to authenticate the webhook request and ensure it comes from a trusted source.
    Select the authentication type. Please note that the key type "SHA secret" can be used only in auth type "Bearer Token."

  4. Select the authentication type for the output webhook .

 

Click “Submit.“

For more information, visit the key page of this overview and Interaction Webhooks API Overview.