Callback Configuration

Steps to setup callback API configuration to get real-time updates from DICE ID APIs

DICE ID APIs for credential issuance and verification that includes user / customer onboarding are all asynchronous APIs which involves various state changes. Therefore DICE ID platform provides ability to register your APIs on which you can receive the callback based on events.

From this screen you can specify the REST API url and the access parameters. Please make sure to use the same callback APIs in the request body when calling DICE ID APIs.

Once you configure the callback/webhook, then DICE ID platform will start sending/invoking the API at events during the course of connection establishment, credential issuance, credential verification and Schema creation. The callback API will be invoked when:

• User Connection establishment is completed, and Connection becomes ‘active’.

• Credential Offer has been sent to the User.

• Credential is issued to the User.

• Credential is revoked from User.

• Presentation/Verification request is sent to the User.

• Presentation/Verification proof is verified.

• New Credential Schema gets created.

The payload that will be sent to your callback API will comrpise of the following fields

{
    "type": "string", // possible values are: "connections", "credentials", "verifications" or "schema"
	"action": "string", // possible values are:
    // 	If the 'type' is "connections" then "response", or "active"
    // 	If the 'type' is "credentials" then "offer_sent", "credential_acked" or "credential_revoked"
    // 	If the 'type' is "verifications" then "request_sent" or "verified"
    // 	If the 'type' is "schema" then "create schema"
    "name": "string", // User Name
    "email": "string", // User email
    "connection_id": "string", // 	Unique ID of the connection establishment operation. If the 'type' is "connections" then this field gets populated 
	"credential_exchange_id": "string", // 	Unique ID of the credential issuance operation. If the 'type' is "credentials" then this field gets populated 
	"presentation_exchange_id": "string", // 	Unique ID of the credential verification operation. If the 'type' is "verifications" then this field gets populated
	"schema_id": "string" // 	Unique ID of the Schema creation operation. If the 'type' is "schema" then this field gets populated 
}

In case, you don’t need these callbacks/webhooks any more from DICE then you can delete the callback setup through DICE ID web portal from same ‘Callback Configuration’ page