A new version of this API is now available.

EBSI will stop supporting this maintenance version in the upcoming months. You can find the details of the upcoming release and affected endpoints in the change log. Please contact eu-ebsi@ec.europa.eu if this upcoming release might cause a high impact on either an ongoing development or a piloting demonstration.

Get a DID document

Last updated on Oct 18, 2023

GET /did-registry/v3/identifiers/:did

Gets the DID document corresponding to the DID.

Request

Path Parameters

did stringrequired

A DID to be resolved.

Examples:

Example: did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw

Responses

Success. A user wallet gets DID resolution (CT ONBOARD_063)

application/did+ld+json

Schema
Example (from schema)
Success

Schema

@context object

DID document @context

oneOf

MOD1
MOD2

string uri

property name* any

DID document as a JSON-LD document

{
  "@context": "string"
}

{
  "@context": [
    "https://www.w3.org/ns/did/v1",
    "https://w3id.org/security/suites/jws-2020/v1"
  ],
  "id": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw",
  "verificationMethod": [
    {
      "id": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-1",
      "type": "JsonWebKey2020",
      "controller": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw",
      "publicKeyJwk": {
        "kty": "EC",
        "crv": "secp256k1",
        "x": "Ep9OMTayvbrJZYrB_qrS-e6JXNAVbGAhS18E09Los6g",
        "y": "mu5kfpcdbG7RLAj0clEg05s7yhdxQ2d6bSww4RBWqWU"
      }
    },
    {
      "id": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-2",
      "type": "JsonWebKey2020",
      "controller": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw",
      "publicKeyJwk": {
        "kty": "EC",
        "crv": "P-256",
        "x": "a3eW4ByH5abaHIMYrjbWKhIh_HAilcVM-BvHsk3YUE4",
        "y": "vdNbhQKv39Ta4x-1nwtIkCt3n7QX-qyKqgTZbTQ2O5Q"
      }
    },
    {
      "id": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-3",
      "type": "JsonWebKey2020",
      "controller": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw",
      "publicKeyJwk": {
        "kty": "RSA",
        "n": "ulFF1PmOgWoLrlCCi1sRdeQIGTtj7IXAfasKhuvrT6C2lGiwP3Oy6Fhb5PZdODs81d3-WB9zVGHUVx9Lrkfd0HkIeDHGaCIslUY-X9kgeYtvvgGRKqIyrgo0vmZi8q_SiP5O7XIFhJMbj6lf_iubpPDYu7psh_Dw_M1FDNlfLOidGIpYudE8wbwkbZm_wKq5rGRKsnfwBp2fs2jIFomu2jy0g6oBOsWfgZKYI4sWueJDNok-HFLGZlDtVCorqOGNc1bHUi0LyDFxLk-jr_lQ58erWsrqBmXrxl8ZHRS3kUeiQ1eZZt8xzwvYBzCyEniokKrwmwvWvD7VkSNdJJsirQ",
        "e": "AQAB"
      }
    },
    {
      "id": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-4",
      "type": "JsonWebKey2020",
      "controller": "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw",
      "publicKeyJwk": {
        "kty": "OKP",
        "crv": "Ed25519",
        "x": "4r9_nYy4tcS_BEdyxeseS4_dNkZAjCqM5v7F-r-bV4Q"
      }
    }
  ],
  "authentication": [
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-1",
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-2",
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-3",
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-4"
  ],
  "assertionMethod": [
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-1",
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-2",
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-3",
    "did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw#keys-4"
  ]
}

Bad Request

application/problem+json

Schema
Example (from schema)
Invalid {did} Parameter

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "The format of {did} parameter is not valid"
}

Not found

application/problem+json

Schema
Example (from schema)
DID Not Found

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

Internal Server Error

application/json

Schema
Example (from schema)
Internal Server Error

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

{
  "title": "Internal error",
  "status": 500,
  "detail": "Internal error"
}

/did-registry/v3/identifiers/:did

Request​

Path Parameters

Responses​

Request

Responses