DID Management

Generate DID documents

post

Generates new DID documents for the specified methods.

Authorizations

AuthorizationstringRequired

One-Click access token (Authorization: Bearer )

Body

methodsstring[]Required

DID method which will be used for generate DID documents

Example: ["empe","empe-testnet","web"]

Responses

201

The DID documents have been successfully created.

application/json

@contextstringRequired

JSON-LD context for the DID document

Example: https://www.w3.org/ns/did/v1

idstringRequired

The DID

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

controllerstringRequired

The controller of the DID document

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

verificationMethodobjectRequired

The verification methods associated with the DID document

Example:

[{"id":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1","type":"Ed25519VerificationKey2020","controller":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA","publicKeyMultibase":"z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"}]

authenticationstring[]Required

Authentication methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

assertionMethodstring[]Required

Assertion methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

capabilityInvocationstring[]Optional

Capability invocation methods

capabilityDelegationstring[]Optional

Capability delegation methods

keyAgreementstring[]Optional

Key agreement methods

servicestring[]Required

Services associated with the DID document

alsoKnownAsstring[]Optional

Alternative identifiers for the DID

400

Validation error.

application/json

401

Missing or invalid authentication token.

application/json

post/did/generate

POST /did/generate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "methods": [
    "empe",
    "empe-testnet",
    "web"
  ]
}

[
  {
    "@context": "https://www.w3.org/ns/did/v1",
    "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
    "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
    "verificationMethod": [
      {
        "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1",
        "type": "Ed25519VerificationKey2020",
        "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
        "publicKeyMultibase": "z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"
      }
    ],
    "authentication": [
      "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
    ],
    "assertionMethod": [
      "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
    ],
    "capabilityInvocation": [],
    "capabilityDelegation": [],
    "keyAgreement": [],
    "service": [],
    "alsoKnownAs": []
  }
]

Import DID documents from mnemonics

post

Restores/creates DID documents for the specified methods using a mnemonic phrase.

Authorizations

AuthorizationstringRequired

One-Click access token (Authorization: Bearer )

Body

methodsstring[]Required

DID method which will be used for generate DID documents

Example: ["empe","empe-testnet","web"]

mnemonicsstringRequired

Mnemonic phrase used to restore the DID(s).

Example: abandon ability able about above absent absorb abstract absurd abuse access accident

Responses

201

The DID documents have been successfully imported.

application/json

@contextstringRequired

JSON-LD context for the DID document

Example: https://www.w3.org/ns/did/v1

idstringRequired

The DID

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

controllerstringRequired

The controller of the DID document

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

verificationMethodobjectRequired

The verification methods associated with the DID document

Example:

[{"id":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1","type":"Ed25519VerificationKey2020","controller":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA","publicKeyMultibase":"z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"}]

authenticationstring[]Required

Authentication methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

assertionMethodstring[]Required

Assertion methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

capabilityInvocationstring[]Optional

Capability invocation methods

capabilityDelegationstring[]Optional

Capability delegation methods

keyAgreementstring[]Optional

Key agreement methods

servicestring[]Required

Services associated with the DID document

alsoKnownAsstring[]Optional

Alternative identifiers for the DID

400

Validation error.

application/json

401

Missing or invalid authentication token.

application/json

post/did/import

POST /did/import HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "methods": [
    "empe",
    "empe-testnet",
    "web"
  ],
  "mnemonics": "abandon ability able about above absent absorb abstract absurd abuse access accident"
}

[
  {
    "@context": "https://www.w3.org/ns/did/v1",
    "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
    "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
    "verificationMethod": [
      {
        "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1",
        "type": "Ed25519VerificationKey2020",
        "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
        "publicKeyMultibase": "z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"
      }
    ],
    "authentication": [
      "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
    ],
    "assertionMethod": [
      "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
    ],
    "capabilityInvocation": [],
    "capabilityDelegation": [],
    "keyAgreement": [],
    "service": [],
    "alsoKnownAs": []
  }
]

Retrieve a DID document by method

get

Fetches the existing DID document for the specified method. For EMPE_TESTNET, the underlying network must be TESTNET.

Authorizations

AuthorizationstringRequired

One-Click access token (Authorization: Bearer )

Path parameters

methodstring · enumRequired

The DID method to resolve.

Possible values:

Responses

200

The DID document has been successfully retrieved.

application/json

@contextstringRequired

JSON-LD context for the DID document

Example: https://www.w3.org/ns/did/v1

idstringRequired

The DID

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

controllerstringRequired

The controller of the DID document

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

verificationMethodobjectRequired

The verification methods associated with the DID document

Example:

[{"id":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1","type":"Ed25519VerificationKey2020","controller":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA","publicKeyMultibase":"z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"}]

authenticationstring[]Required

Authentication methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

assertionMethodstring[]Required

Assertion methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

capabilityInvocationstring[]Optional

Capability invocation methods

capabilityDelegationstring[]Optional

Capability delegation methods

keyAgreementstring[]Optional

Key agreement methods

servicestring[]Required

Services associated with the DID document

alsoKnownAsstring[]Optional

Alternative identifiers for the DID

400

The method query parameter is missing or invalid.

application/json

404

No DID document exists for the requested method.

application/json

get/dids/{method}

GET /dids/{method} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@context": "https://www.w3.org/ns/did/v1",
  "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
  "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
  "verificationMethod": [
    {
      "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1",
      "type": "Ed25519VerificationKey2020",
      "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
      "publicKeyMultibase": "z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"
    }
  ],
  "authentication": [
    "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
  ],
  "assertionMethod": [
    "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
  ],
  "capabilityInvocation": [],
  "capabilityDelegation": [],
  "keyAgreement": [],
  "service": [],
  "alsoKnownAs": []
}

Retrieve all DID documents for authenticated user

get

Fetches all DID documents from all networks

Authorizations

AuthorizationstringRequired

One-Click access token (Authorization: Bearer )

Responses

200

The DID documents have been successfully retrieved

application/json

@contextstringRequired

JSON-LD context for the DID document

Example: https://www.w3.org/ns/did/v1

idstringRequired

The DID

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

controllerstringRequired

The controller of the DID document

Example: did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA

verificationMethodobjectRequired

The verification methods associated with the DID document

Example:

[{"id":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1","type":"Ed25519VerificationKey2020","controller":"did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA","publicKeyMultibase":"z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"}]

authenticationstring[]Required

Authentication methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

assertionMethodstring[]Required

Assertion methods for the DID document

Example: ["did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"]

capabilityInvocationstring[]Optional

Capability invocation methods

capabilityDelegationstring[]Optional

Capability delegation methods

keyAgreementstring[]Optional

Key agreement methods

servicestring[]Required

Services associated with the DID document

alsoKnownAsstring[]Optional

Alternative identifiers for the DID

get/dids

GET /dids HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The DID documents have been successfully retrieved

[
  {
    "@context": "https://www.w3.org/ns/did/v1",
    "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
    "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
    "verificationMethod": [
      {
        "id": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1",
        "type": "Ed25519VerificationKey2020",
        "controller": "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA",
        "publicKeyMultibase": "z6MkoTHsg2YMW1qSw7pdPcyKyKR4jaHmkKMM2cQEKDSNmhd7"
      }
    ],
    "authentication": [
      "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
    ],
    "assertionMethod": [
      "did:empe:testnet:EiBZK8AeSe3xq-hiMgL2-zkSe8XAoIcMNxQmoK3vpE97kA#key-1"
    ],
    "capabilityInvocation": [],
    "capabilityDelegation": [],
    "keyAgreement": [],
    "service": [],
    "alsoKnownAs": []
  }
]

Serve did:web did.json for a given user

get

Authorizations

AuthorizationstringRequired

One-Click access token (Authorization: Bearer )

Path parameters

idstringRequired

User id

Responses

200Success

No content

get/did/user/{id}/did.json

GET /did/user/{id}/did.json HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

PreviousAPI Reference

NextCredential Management

Last updated 8 months ago