Skip to main content

Create a DID

PUT 
/:ssiId/ssi/v1/dids/quarkid

Endpoint Description​

This endpoint accepts four optional parameters. It is recommended to specify at least one to describe the transport layer service associated with the DID being created.

A DID without a defined transport layer cannot receive messages directly, although it can send messages to other DIDs via their transport layers. This specification is crucial for Issuers who want to establish the transport layer when generating verifiable credentials. This way, when someone requests a credential, they do so using the transport layer established by the issuer.

WebSocket and DWN Channel​

Additionally, the API provides a WebSocket channel and a DWN channel, which can be used to create the DID and connect with other DIDs.

The WebSocket channel is available at: "https://sandbox-ssi-ws.extrimian.com"

The DWN channel is available at: "https://dwn.extrimian.com"

Webhook URL​

Specifies the webhook URL where the API will send notifications when important events occur. A webhook is a mechanism that allows one application to automatically notify another when something relevant happens, such as issuing a new credential or verifying it. If this parameter is provided, the API will send events related to the newly created DID to the specified URL.

While this field is optional, it will be necessary, especially to obtain the result of a verification flow.

DID Method​

Defines the DID method to use for creating the new DID. A DID (Decentralized Identifier) can be created using different methods, which define how the DID is resolved and what features it has. If you wish to use our custom method, you must specify "did:quarkid" as the value for this parameter.

Request​

Path Parameters

    ssiId stringrequired

Query Parameters

    websocket stringrequired

    Websocket URL

    dwn stringrequired

    DWN service URL

    verificationRulesEndpoint stringrequired

    Business Logic URL

    apikey stringrequired

Body

required
    websocket stringrequired

    WebSocket service configured for this DID

    dwn stringrequired

    DWN service configured for this DID

    webhookURL stringrequired

    Webhook URL for DID communication events

    verificationRulesEndpoint stringrequired

    Business Logic Endpoint to DID verification

    didMethod stringrequired

    DID method used for DID creation

Responses​

Returns created DID

Schema
    did stringrequired

    Created DID

Loading...