Get platform DID document

GET

/platform/api/v1/protected/did-doc

const url = 'https://localhost:8080/platform/api/v1/protected/did-doc';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:8080/platform/api/v1/protected/did-doc \
  --header 'Authorization: <Authorization>'

Return the DID document for the shared organization-key DID key; also mounted at /platform/api/v1/protected/did-doc for SDK AuthServiceSigner compatibility

Authorizations

BearerAuth
ApiKeyAuth

Responses

200

DID Document

application/json

The W3C DID document for a key, in did:key form

object

@context

string

assertionMethod

Array<string>

authentication

DID URLs into verificationMethod

Array<string>

string

verificationMethod

Array<object>

A public key in a DID document, published as a JWK

object

controller

string

publicKeyJwk

object

type

string

Example

{
  "@context": "https://www.w3.org/ns/did/v1",
  "id": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
  "verificationMethod": [
    {
      "controller": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
      "id": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme#zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
      "type": "JsonWebSignature2020"
    }
  ]
}

401

Unauthorized - Invalid or missing credential

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}