Sign in
Dids

List DIDs

Returns a page of local DID records. Filters are applied before pagination. role is parsed from MANAGED or EXTERNAL; expand accepts document, keys, or all as a comma-separated query value.

get/identifiers

Query parameters

methodstring

Filter by DID method (e.g., key, web, ion).

roleDidRole — unresolved $ref

Filter by DID role.

aliasstring

Filter by exact alias match.

searchstring

Case-insensitive contains search on DID string and alias.

includeDeactivatedboolean

Include deactivated DIDs in results.

includeDeletedboolean

Include soft-deleted DIDs in results.

pageinteger

Page number (zero-based).

sizeinteger

Page size.

sort'createdAt' | 'updatedAt' | 'did' | 'method' | 'alias'

Sort field.

sortDirection'ASC' | 'DESC'

Sort direction.

expandstring[]

Comma-separated list of optional projections to include inline on each returned Did. The default response carries only the lightweight summary fields per item; keep this default for cheap pagination over large result sets. all is shorthand for every supported projection. Adding new values is backward-compatible.

Parameters

./common-components.yml#/components/parameters/CorrelationId — unresolved $ref

Response

Paginated list of DIDs.

itemsDid[] required— unresolved $ref
pagePageMeta required— unresolved $ref

Example response

{
  "items": [
    {
      "did": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK",
      "method": "key",
      "alias": "rest-e2e-alias",
      "role": "MANAGED",
      "createdAt": "2026-06-06T09:00:00Z",
      "updatedAt": "2026-06-06T09:00:00Z"
    }
  ],
  "page": {
    "limit": 10,
    "offset": 0,
    "page": 0,
    "size": 10,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}

Changes