# @cef-ebsi/ebsi-did-resolver

> Resolve EBSI DID documents

Latest version **4.1.0** (published 2025-06-27) · EUPL-1.2 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @cef-ebsi/ebsi-did-resolver
pnpm add @cef-ebsi/ebsi-did-resolver
yarn add @cef-ebsi/ebsi-did-resolver
bun add @cef-ebsi/ebsi-did-resolver
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.1.0 |
| Published | 2025-06-27 |
| First published | 2021-10-08 |
| Weekly downloads | 0 |
| License | EUPL-1.2 |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 54.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | iamtxena, yhuard, joticajulian, zgorizzo, maurolucc |

## Links

- npm: https://www.npmjs.com/package/@cef-ebsi/ebsi-did-resolver
- Repository: https://ec.europa.eu/digital-building-blocks/code/scm/ebsi/core-libs
- npm.io page: https://npm.io/package/@cef-ebsi/ebsi-did-resolver

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.9.0
- [did-resolver](https://npm.io/package/did-resolver.md) ^4.1.0
- [multiformats](https://npm.io/package/multiformats.md) ^9.6.2

## Recent versions

- 4.1.0 (latest) — 2025-06-27
- 4.2.0-alpha.3 (alpha) — 2026-01-19
- 4.0.5-alpha.0 (next) — 2024-12-10
- 4.2.0-alpha.2 — 2026-01-09
- 4.2.0-alpha.1 — 2025-09-24
- 4.1.1-alpha.0 — 2025-08-04
- 4.1.0-alpha.0 — 2025-06-24
- 4.0.6 — 2025-05-27
- 4.0.6-alpha.2 — 2025-03-19
- 4.0.6-alpha.1 — 2025-03-12
- 4.0.6-alpha.0 — 2025-03-07
- 4.0.5 — 2025-02-03
- 4.0.5-alpha.1 — 2025-01-28
- 4.0.4 — 2024-12-10
- 4.0.4-alpha.0 — 2024-11-25
- … 44 more at https://npm.io/package/@cef-ebsi/ebsi-did-resolver/versions

## README

![EBSI Logo](https://ec.europa.eu/digital-building-blocks/sites/images/logo/default-space-logo.svg)

# EBSI DID Resolver

This library supports the proposed `did:ebsi` method from EBSI. This DID method is meant to be used by Legal Entities only.
For Natural Persons, the [`did:key` method](https://www.npmjs.com/package/@cef-ebsi/key-did-resolver) must be used.

In order to resolve DID documents, the EBSI DID resolver requires the [`did-resolver`](https://github.com/decentralized-identity/did-resolver) library, which is the primary interface for resolving DIDs.

## Table of Contents

1. [Installation](#installation)
2. [Resolving a DID document](#resolving-a-did-document)
3. [Creating a DID](#creating-a-did)
4. [Axios config defaults](#axios-config-defaults)
5. [License](#license)

## Installation

```bash
npm install @cef-ebsi/ebsi-did-resolver
```

or if you use `yarn`:

```bash
yarn add @cef-ebsi/ebsi-did-resolver
```

## Resolving a DID document

The library provides a resolver that is meant to be used through the [`did-resolver`](https://github.com/decentralized-identity/did-resolver) aggregator.

```js
import { Resolver } from "did-resolver";
import { getResolver } from "@cef-ebsi/ebsi-did-resolver";

// You must set the address of the DID Registry to be used in order to resolve Legal Entities DID documents
const resolverConfig = {
  registry: "https://api-pilot.ebsi.eu/did-registry/v5/identifiers",
};

// getResolver will return an object with a key/value pair of { "ebsi": resolver } where resolver is a function used by the generic DID resolver.
const ebsiResolver = getResolver(resolverConfig);
const didResolver = new Resolver(ebsiResolver);

didResolver
  .resolve("did:ebsi:zub5ZZUfHLLptCduwEy8xRj")
  .then((doc) => console.log);

// You can also use ES7 async/await syntax
const doc = await didResolver.resolve("did:ebsi:zub5ZZUfHLLptCduwEy8xRj");
```

## Creating a DID

The library exposes a method allowing you to create a DID from the given subject identifier bytes:

```js
import { util } from "@cef-ebsi/ebsi-did-resolver";
import { randomBytes } from "node:crypto";

const subjectIdentifierBytes = randomBytes(16); // An array of 16 random bytes
const did = util.createDid(subjectIdentifierBytes);
// Example: "did:ebsi:ztRBFfMCY7VAGHH1Ba8Q5o9"
```

## Axios config defaults

The library uses the global [axios](https://axios-http.com) instance to make HTTP requests. If needed, you can specify config defaults. More information on axios configuration can be found [here](https://axios-http.com/docs/config_defaults).

For instance, if you want to override the default HTTPS agent with a custom agent using [https-proxy-agent](https://www.npmjs.com/package/https-proxy-agent), you can do it like so:

```js
import axios from "axios";
import { HttpsProxyAgent } from "https-proxy-agent";

axios.defaults.httpsAgent = new HttpsProxyAgent("http://168.63.76.32:3128");
```

## License

Copyright (C) 2025 European Union

This program is free software: you can redistribute it and/or modify it under the terms of the EUROPEAN UNION PUBLIC LICENCE v. 1.2 as published by the European Union.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EUROPEAN UNION PUBLIC LICENCE v. 1.2 for further details.

You should have received a copy of the EUROPEAN UNION PUBLIC LICENCE v. 1.2. along with this program. If not, see <https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12>.

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