# web-did-resolver

> Resolve DID documents from an https domain

Latest version **2.0.32** (published 2025-12-03) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install web-did-resolver
pnpm add web-did-resolver
yarn add web-did-resolver
bun add web-did-resolver
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.0.32 |
| Published | 2025-12-03 |
| First published | 2019-09-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 63.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 102 |
| Author | Mike Xu |
| Maintainers | simonas-notcat, mirceanis, uport-automation-bot |

## Links

- npm: https://www.npmjs.com/package/web-did-resolver
- Repository: https://github.com/decentralized-identity/web-did-resolver
- Homepage: https://github.com/decentralized-identity/web-did-resolver#readme
- Issues: https://github.com/decentralized-identity/web-did-resolver/issues
- npm.io page: https://npm.io/package/web-did-resolver

## Dependencies (2)

- [cross-fetch](https://npm.io/package/cross-fetch.md) ^4.1.0
- [did-resolver](https://npm.io/package/did-resolver.md) ^4.1.0

## Recent versions

- 2.0.32 (latest) — 2025-12-03
- 2.0.31 — 2025-10-20
- 2.0.30 — 2025-03-29
- 2.0.29 — 2025-01-24
- 2.0.28 — 2025-01-24
- 2.0.27 — 2023-07-03
- 2.0.26 — 2023-07-03
- 2.0.25 — 2023-07-02
- 2.0.24 — 2023-05-14
- 2.0.23 — 2023-04-03
- 2.0.22 — 2023-03-23
- 2.0.21 — 2022-10-17
- 2.0.20 — 2022-08-03
- 2.0.19 — 2022-06-15
- 2.0.18 — 2022-06-07
- … 30 more at https://npm.io/package/web-did-resolver/versions

## README

[![npm](https://img.shields.io/npm/dt/web-did-resolver.svg)](https://www.npmjs.com/package/web-did-resolver)
[![npm](https://img.shields.io/npm/v/web-did-resolver.svg)](https://www.npmjs.com/package/web-did-resolver)
[![codecov](https://codecov.io/gh/decentralized-identity/web-did-resolver/branch/develop/graph/badge.svg)](https://codecov.io/gh/decentralized-identity/web-did-resolver)

# Web DID Resolver

This library is intended to represent domains accessed through https as
[Decentralized Identifiers](https://w3c.github.io/did-core/#identifier)
and retrieve an associated [DID Document](https://w3c.github.io/did-core/#did-document-properties)

It supports the proposed [`did:web` method spec](https://w3c-ccg.github.io/did-method-web/) from
the [W3C Credentials Community Group](https://w3c-ccg.github.io).

It requires the `did-resolver` library, which is the primary interface for resolving DIDs.

## DID method

To encode a DID for an HTTPS domain, simply prepend `did:web:` to domain name.

eg: `https://example.com -> did:web:example.com`

## DID Document

The DID resolver takes the domain and forms a [well-known URI](https://tools.ietf.org/html/rfc5785)
to access the DID Document.

For a did `did:web:example.com`, the resolver will attempt to access the document at
`https://example.com/.well-known/did.json`

A minimal DID Document might contain the following information:

```json
{
  "@context": "https://w3id.org/did/v1",
  "id": "did:web:example.com",
  "publicKey": [
    {
      "id": "did:web:example.com#owner",
      "type": "Secp256k1VerificationKey2018",
      "controller": "did:web:example.com",
      "publicKeyHex": "04ab0102bcae6c7c3a90b01a3879d9518081bc06123038488db9cb109b082a77d97ea3373e3dfde0eccd9adbdce11d0302ea5c098dbb0b310234c8689501749274"
    }
  ],
  "assertionMethod": [ "did:web:example.com#owner" ],
  "authentication": [ "did:web:example.com#owner" ]
}
```

Note: this example uses the `Secp256k1VerificationKey2018` type and an `publicKeyHex` as a publicKey entry, signaling
that this DID is claiming to control the private key associated with that publicKey.

## Resolving a DID document

The resolver presents a simple `resolver()` function that returns a ES6 Promise returning the DID document.

```js
import { Resolver } from 'did-resolver'
import { getResolver } from 'web-did-resolver'

const webResolver = getResolver()

const didResolver = new Resolver({
    ...webResolver
    //...you can flatten multiple resolver methods into the Resolver
})

didResolver.resolve('did:web:uport.me').then(doc => console.log(doc))

// You can also use ES7 async/await syntax
;(async () => {
    const doc = await didResolver.resolve('did:web:uport.me')
    console.log(doc)
})();
```

---
_Source: https://npm.io/package/web-did-resolver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._