Did management

DID management functions enable the following:

• List - lists the available DIDs

• Load - loads a DID by the specified id

• Delete - deletes a DID by the specified url

• Create - creates a new DID

• Resolve - resolves a DID to a document

• Import - import a DID

For more info on DIDs, go here.

List DID

The /did endpoint lists the available DIDs.

curl

curl -X 'GET' \
  'https://custodian.ssikit.walt.id/did' \
  -H 'accept: application/json'

Request body schema

Response body schema

E.g. List the available DIDs

curl

curl -X 'GET' \
  'https://custodian.ssikit.walt.id/did' \
  -H 'accept: application/json'

Response body

Load DID

The /did/{id} endpoint loads a DID specified by:

• id path parameter (required) - the DID url string

curl

curl -X 'GET' \
  'https://custodian.ssikit.walt.id/{id}' \
  -H 'accept: application/json'

Request body schema

Response body schema

E.g Load the DID having the id = did:web:walt.id.

curl

curl -X 'GET' \
  'https://custodian.ssikit.walt.id/did/did%3Aweb%3Awalt.id' \
  -H 'accept: application/json'

Response body

Delete DID

The /did/{id} deletes the DID specified by:

• url - path parameter (required) - the DID url string

curl

curl -X 'DELETE' \
  'https://custodian.ssikit.walt.id/did/{id}' \
  -H 'accept: application/json'

Request body schema

Response body schema

E.g. Delete the DID having id = did:web:walt.id.

curl

curl -X 'DELETE' \
  'https://custodian.ssikit.walt.id/did/did%3Aweb%3Awalt.id' \
  -H 'accept: application/json'

Create DID

The /did/create endpoint creates a DID.

curl

curl -X 'POST' \
  'https://custodian.ssikit.walt.id/did/create' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '<request-body>'

Request body schema

Response body schema

The method and keyAlias properties are common for all did-method requests, method being required, while keyAlias - optional (if not specified, a new key will be automatically created using the default algorithm according to the did-method). The method-dependent options have default values, if not specified otherwise. Below are the available properties by did-method.

key

{
    "method": "key",
    "keyAlias": "string",
    "useJwkJcsPub": "boolean"
}

• useJwkJcsPub (default) - false - specifies whether to create a did:key using the jwk_jcs-pub multicodec (code: 0xeb51)

web

ebsi

cheqd

iota

jwk

E.g. Create a DID using the web method having the domain set to walt.id.

curl

curl -X 'POST' \
  'https://custodian.ssikit.walt.id/did/create' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "web",
  "didWebDomain": "walt.id"
}'

Request body

Response body

Resolve DID

The /did/resolve endpoint resolves a DID.

curl

curl -X 'POST' \
  'https://custodian.ssikit.walt.id/did/resolve' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '<request-body>'

Request body schema

Response body schema

E.g. Reslove the DID having id = did:key:z6MkkLmAVeM3P6B2LJ2xGrK1wVojCoephK4G9VrCcct42ADX.

curl

curl -X 'POST' \
  'https://custodian.ssikit.walt.id/did/resolve' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "did": "did:key:z6MkkLmAVeM3P6B2LJ2xGrK1wVojCoephK4G9VrCcct42ADX"
}'

Request body

Response body

Import DID

The /did/import endpoint resolves and imports the DID to the underlying data store.

curl

curl -X 'POST' \
  'https://custodian.ssikit.walt.id/did/import' \
  -H 'accept: application/json' \
  -H 'Content-Type: text/plain' \
  -d '<request-body>'

Request body schema

Response body schema

E.g. Import DID having id = did:key:z6Mkm8NbvDnnxJ2t5zLGSkYGCWZiqq11Axr58xQ3ZG1Jss3z.

curl

curl -X 'POST' \
  'https://custodian.ssikit.walt.id/did/import' \
  -H 'accept: application/json' \
  -H 'Content-Type: text/plain' \
  -d 'did:key:z6Mkm8NbvDnnxJ2t5zLGSkYGCWZiqq11Axr58xQ3ZG1Jss3z'

Request body