Learn

DIDs

Create a DID

Takes a supported DID method and returns a new DID with its generated keys and required information. This endpoint also registers the DID Document when applicable.

MATTR VII currently supports creating DIDs of the following methods:

  • did:key: The most basic type of DID. The public key forms the DID and has no further data associated with it.
  • did:web: This type of DID requires hosting the DID document on a publicly accessible domain in order to make the document and its contents available.

Analytic events

  • DID_CREATE_START
  • DID_CREATE_SUCCESS
  • DID_CREATE_FAIL
SecuritybearerAuth
Request
Request Body schema: application/json
required

Options for creating the decentralized identifier

method
required
string

Used to determine the type of DID to be created based on its DID method.

Enum: "key" "web"
object non-empty

To define a key type for a did:key or to define a domain for did:web

Responses
201

DID document created

400

Bad request

post/core/v1/dids
Request samples
application/json
{
  • "method": "web",
  • "options": {
    }
}
Response samples
application/json
{
  • "did": "did:web:learn.vii.au01.mattr.global",
  • "registrationStatus": "COMPLETED",
  • "localMetadata": {
    }
}

Retrieve a list of DIDs

Returns a list of all DIDs (Decentralized Identifiers) managed by the tenant and their associated meta-data.

Analytic events

  • DID_RETRIEVE_LIST_START
  • DID_RETRIEVE_LIST_SUCCESS
  • DID_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of the list, default 100

Example: limit=2
cursor
string

Starting point for the list

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

A list of DIDs

get/core/v1/dids
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
Resolve a DID
Retrieves a DID and its metadata from the tenant by its URI. This may involve a network call depending on the method involved:


    

  • For did:key the public key is encapsulated in the DID URI itself.
    • 

  • For did:web it must be resolved by accessing the /.well-known/did.json path on its domain.
    • 



Analytic events


    

  • DID_RETRIEVE_START
    • 

  • DID_RETRIEVE_SUCCESS
    • 

  • DID_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <did> 
DID


 
 Example:  did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9
Responses 
200
A DID Document and its meta-data


404
Not Found


get/core/v1/dids/{id}
Request samples 
Response samples 
application/json
{
  • "did": "did:web:learn.vii.au01.mattr.global",
  • "registrationStatus": "COMPLETED",
  • "localMetadata": {
    }
}
Delete a DID
Deletes a DID and all associated metadata by providing its URI. This includes all the removal of all associated private keys from the Key Management System (KMS).




For ledger-based DIDs the public DID Document will still be available. This means that for did:web you will need to manually remove the did.json from your hosted domain.




Analytic events


    

  • DID_DELETE_START
    • 

  • DID_DELETE_SUCCESS
    • 

  • DID_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <did> 
DID


 
 Example:  did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9
Responses 
204
DID successfully deleted


400
Bad request


404
Not Found


delete/core/v1/dids/{id}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Validation Error",
  • "details": [
    ]
}
Well known DID configuration
Returns a list of Decentralized Identifier (DID) Configuration entries from the tenant. These are automatically created for all DIDS created on a tenant so that they can be used by any party aiming to establish and verify the domain-DID linkage by exposing cryptographic proofs. Thus, this endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party. Refer to Well Known DID Configuration on the Decentralized Identity Foundation website for more information.


Responses 
200
List of DID Configuration entries


get/.well-known/did-configuration
Request samples 
Response samples 
application/json
{
  • "entries": [
    ]
}
➔ Next to IACA