GET 
/did-registry/v3/identifiers/:did/versions/:versionId/metadata

Returns a list of DID document metadata.

Request

Path Parameters

did stringrequired

A DID to be resolved.

Examples:

DID

Example: did:ebsi:zbM8cCuoBMFNLeQyLiVFyxw

versionId stringrequired

A unique version ID.

Examples:

Version ID

Example: 0xa009395f9e2a7809f1b550e0efbe2443dce931fe747d269a5c312e5ad75f88e1

Query Parameters

page[after] string

Cursor that points to the end of the page of data that has been returned.

page[size] integer

Defines the maximum number of objects that may be returned.

Responses

200

Success

application/json

Schema

Schema

self string

Absolute path to the collection (consult)

items object[]
List of DID document versions
Array [
metadataId string
A unique metadata id.
href string
Link to the resource.
]
total integer

Total number of items across all pages.

pageSize integer

Maximum number of items per page. For the last page, its value should be independent of the number of actually returned items.

links object

Links model used for pagination

last string

URI of the last page

prev string

URI of the previous page

next string

URI of the next page

first string

URI of the first page

Example (from schema)

{
  "self": "string",
  "items": [
    {
      "metadataId": "string",
      "href": "string"
    }
  ],
  "total": 0,
  "pageSize": 0,
  "links": {
    "last": "string",
    "prev": "string",
    "next": "string",
    "first": "string"
  }
}

Success

{
  "self": "https://api-pilot.ebsi.eu/did-registry/v3/identifiers/did:ebsi:z25F87e2MyLKF7DViuHi5b4z/versions/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c/metadata?page[after]=1&page[size]=10",
  "items": [
    {
      "metadataId": "0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c",
      "href": "https://api-pilot.ebsi.eu/did-registry/v3/identifiers/did:ebsi:z25F87e2MyLKF7DViuHi5b4z/versions/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c/metadata/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c"
    }
  ],
  "total": 1,
  "pageSize": 10,
  "links": {
    "first": "https://api-pilot.ebsi.eu/did-registry/v3/identifiers/did:ebsi:z25F87e2MyLKF7DViuHi5b4z/versions/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c/metadata?page[after]=1&page[size]=10",
    "prev": "https://api-pilot.ebsi.eu/did-registry/v3/identifiers/did:ebsi:z25F87e2MyLKF7DViuHi5b4z/versions/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c/metadata?page[after]=1&page[size]=10",
    "next": "https://api-pilot.ebsi.eu/did-registry/v3/identifiers/did:ebsi:z25F87e2MyLKF7DViuHi5b4z/versions/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c/metadata?page[after]=1&page[size]=10",
    "last": "https://api-pilot.ebsi.eu/did-registry/v3/identifiers/did:ebsi:z25F87e2MyLKF7DViuHi5b4z/versions/0x43f83ef52855e76833f7cf2552d1bee82f8de198e718a1da8a45df1a1616fe8c/metadata?page[after]=1&page[size]=10"
  }
}

400

Bad Request Error

application/problem+json

Schema

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.

Example (from schema)

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

Bad Paging Request

{
  "title": "Bad Paging Request",
  "status": 400,
  "detail": "PageSize should not be greater than 50"
}

Invalid {did} Parameter

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

Invalid {versionId} Parameter

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

404

Not found

application/problem+json

Schema

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.

Example (from schema)

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

DID Not Found

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

Version ID Not Found

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

500

Internal Server Error

application/problem+json

Schema

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.

Example (from schema)

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

Internal Server Error

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

Loading...