decentralized-identity / universal-resolver

Universal Resolver implementation and drivers.

Universal Resolver

The Universal Resolver resolves Decentralized Identifiers (DIDs) across many different DID methods, based on the W3C DID Core 1.0 and DID Resolution specifications. It is a work item of the DIF Identifiers&Discovery Working Group.

See this blog post and this webinar for an introduction.

See https://dev.uniresolver.io/ for a DIF-hosted instance of the Universal Resolver that can be used for testing purposes. See Docker Hub for images.

Quick Start

You can deploy the Universal Resolver on your local machine by cloning this Github repository, and using docker-compose to build and run the Universal Resolver as well as its drivers.

git clone https://github.com/decentralized-identity/universal-resolver
cd universal-resolver/
docker-compose -f docker-compose.yml pull
docker-compose -f docker-compose.yml up

You should then be able to resolve identifiers locally using simple curl requests as follows:

curl -X GET http://localhost:8080/1.0/identifiers/did:jwk:eyJraWQiOiJ1cm46aWV0ZjpwYXJhbXM6b2F1dGg6andrLXRodW1icHJpbnQ6c2hhLTI1NjpGZk1iek9qTW1RNGVmVDZrdndUSUpqZWxUcWpsMHhqRUlXUTJxb2JzUk1NIiwia3R5IjoiT0tQIiwiY3J2IjoiRWQyNTUxOSIsImFsZyI6IkVkRFNBIiwieCI6IkFOUmpIX3p4Y0tCeHNqUlBVdHpSYnA3RlNWTEtKWFE5QVBYOU1QMWo3azQifQ
curl -X GET http://localhost:8080/1.0/identifiers/did:dyne:demo:FFqGYxShyDGAHd4QyLY1KFCSGBb1mBP9sZebEyBM7JPi
curl -X GET http://localhost:8080/1.0/identifiers/did:sov:WRfXPg8dantKVubE3HX8pw
curl -X GET http://localhost:8080/1.0/identifiers/did:btcr:xz35-jznz-q6mr-7q6
curl -X GET http://localhost:8080/1.0/identifiers/did:v1:test:nym:z6Mkmpe2DyE4NsDiAb58d75hpi1BjqbH6wYMschUkjWDEEuR
curl -X GET http://localhost:8080/1.0/identifiers/did:key:z6Mkfriq1MqLBoPWecGoDLjguo1sB9brj6wT3qZ5BxkKpuP6
curl -X GET http://localhost:8080/1.0/identifiers/did:web:did.actor:alice
curl -X GET http://localhost:8080/1.0/identifiers/did:web:did.actor:bob
curl -X GET http://localhost:8080/1.0/identifiers/did:web:did.actor:mike
curl -X GET http://localhost:8080/1.0/identifiers/did:ethr:mainnet:0x3b0BC51Ab9De1e5B7B6E34E5b960285805C41736
curl -X GET http://localhost:8080/1.0/identifiers/did:ethr:goerli:0x3b0BC51Ab9De1e5B7B6E34E5b960285805C41736
curl -X GET http://localhost:8080/1.0/identifiers/did:ethr:0x5:0x3b0BC51Ab9De1e5B7B6E34E5b960285805C41736
curl -X GET http://localhost:8080/1.0/identifiers/did:ethr:0x02b97c30de767f084ce3080168ee293053ba33b235d7116a3263d29f1450936b71
curl -X GET http://localhost:8080/1.0/identifiers/did:ethr:ewc:0x02b97c30de767f084ce3080168ee293053ba33b235d7116a3263d29f1450936b71
curl -X GET http://localhost:8080/1.0/identifiers/did:ens:vitalik.eth
curl -X GET http://localhost:8080/1.0/identifiers/did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ
curl -X GET http://localhost:8080/1.0/identifiers/did:eosio:eos:eoscanadacom
curl -X GET http://localhost:8080/1.0/identifiers/did:eosio:4667b205c6838ef70ff7988f6e8257e8be0e1284a2f59699054a018f743b1d11:caleosblocks
curl -X GET http://localhost:8080/1.0/identifiers/did:jolo:e76fb4b4900e43891f613066b9afca366c6d22f7d87fc9f78a91515be24dfb21
curl -X GET http://localhost:8080/1.0/identifiers/did:stack:v0:16EMaNw3pkn3v6f2BgnSSs53zAKH4Q8YJg-0
curl -X GET http://localhost:8080/1.0/identifiers/did:hcr:0f674e7e-4b49-4898-85f6-96176c1e30de
curl -X GET http://localhost:8080/1.0/identifiers/did:neoid:priv:b4eeeb80d20bfb38b23001d0659ce0c1d96be0aa
curl -X GET http://localhost:8080/1.0/identifiers/did:elem:ropsten:EiCtwD11AV9e1oISQRHnMJsBC3OBdYDmx8xeKeASrKaw6A
curl -X GET http://localhost:8080/1.0/identifiers/did:github:gjgd
curl -X GET http://localhost:8080/1.0/identifiers/did:ccp:ceNobbK6Me9F5zwyE3MKY88QZLw
curl -X GET http://localhost:8080/1.0/identifiers/did:ont:AN5g6gz9EoQ3sCNu7514GEghZurrktCMiH
curl -X GET http://localhost:8080/1.0/identifiers/did:kilt:4rNTX3ihuxyWkB7wG3oLgUWSBLa2gva1NBKJsBFm7jJZUYfc
curl -X GET http://localhost:8080/1.0/identifiers/did:factom:testnet:6aa7d4afe4932885b5b6e93accb5f4f6c14bd1827733e05e3324ae392c0b2764
curl -X GET http://localhost:8080/1.0/identifiers/did:mpg:7PGGnRdvKKFftSXU3Jw75Vk5npfg
curl -X GET http://localhost:8080/1.0/identifiers/did:io:0x476c81C27036D05cB5ebfe30ae58C23351a61C4A
curl -X GET http://localhost:8080/1.0/identifiers/did:bba:t:45e6df15dc0a7d91dcccd24fda3b52c3983a214fb0eed0938321c11ec99403cf
curl -X GET http://localhost:8080/1.0/identifiers/did:schema:public-ipfs:json-schema:Qma2beXKwZeiUXcaRaQKwbBV1TqyiJnsMTYExUTdQue43J
curl -X GET http://localhost:8080/1.0/identifiers/did:ion:EiClkZMDxPKqC9c-umQfTkR8vvZ9JPhl_xLDI9Nfk38w5w
curl -X GET http://localhost:8080/1.0/identifiers/did:gatc:2xtSori9UQZdTqzxrkp7zqKM4Kj5B4C7
curl -X GET http://localhost:8080/1.0/identifiers/did:icon:01:64aa0a2a479cb47afbf2d18d6f9f216bcdcbecdda27ccba3
curl -X GET http://localhost:8080/1.0/identifiers/did:vaa:3wJVWDQWtDFx27FqvSqyo5xsTsxC
curl -X GET http://localhost:8080/1.0/identifiers/did:unisot:1EjHm7VtgsqNzCkvA8XRgGXZ1UKo1txSM4
curl -X GET http://localhost:8080/1.0/identifiers/did:sol:devnet:2eK2DKs6vdzTEoj842Gfcs6DdtffPpw1iF6JbzQL4TuK
curl -X GET http://localhost:8080/1.0/identifiers/did:lit:AEZ87t1bi5bRxmVh3ksMUi
curl -X GET http://localhost:8080/1.0/identifiers/did:ebsi:z25ZZFS7FweHsm9MX2Qvc6gc
curl -X GET http://localhost:8080/1.0/identifiers/did:emtrust:0x242a5ac36676462bd58a
curl -X GET http://localhost:8080/1.0/identifiers/did:meta:0000000000000000000000000000000000000000000000000000000000005e65
curl -X GET http://localhost:8080/1.0/identifiers/did:tz:tz1YwA1FwpgLtc1G8DKbbZ6e6PTb1dQMRn5x
curl -X GET http://localhost:8080/1.0/identifiers/did:pkh:tz:tz2BFTyPeYRzxd5aiBchbXN3WCZhx7BqbMBq
curl -X GET http://localhost:8080/1.0/identifiers/did:orb:hl:uEiBuxTFn4L_Hn8KsOWo8e9kqWP38MThBaToB_5yV3c5QTg:uoQ-BeEJpcGZzOi8vYmFma3JlaWRveXV5d3B5Zjd5NnA0Zmxiem5pNmh4d2prbGQ2N3ltanlpZnV0dWFwN3RzazUzdHNxank:EiD_igS1OSEftg5BGfisJGOS1rgcx5AkQhX0h1B4dHTUYA
curl -X GET http://localhost:8080/1.0/identifiers/did:oyd:zQmaBZTghndXTgxNwfbdpVLWdFf6faYE4oeuN2zzXdQt1kh
curl -X GET http://localhost:8080/1.0/identifiers/did:moncon:z6MkfrVYbLejh9Hv7Qmx4B2P681wBfPFkcHkbUCkgk1Q8LoA
curl -X GET http://localhost:8080/1.0/identifiers/did:dock:5EAp6DB2pkKuAfbhQiqAXFY4XPZkJrvtWKad4ChDmWwDrC8n
curl -X GET http://localhost:8080/1.0/identifiers/did:mydata:z6MkjgVfx2YE7SUBZBej65E7UHSjAyMLukPvdPjPytpTy1ZM
curl -X GET http://localhost:8080/1.0/identifiers/did:dns:danubetech.com
curl -X GET http://localhost:8080/1.0/identifiers/did:indy:idunion:2GMSLg2A8JXcdYVsPC4Jui
curl -X GET http://localhost:8080/1.0/identifiers/did:everscale:47325e80e3cef5922d3a3583ae5c405ded7bda781cb069f2bc932a6c3d6ec62e
curl -X GET http://localhost:8080/1.0/identifiers/did:ala:quor:redT:ec27f358fd0d11d8934ceb51305622ae79b6ad15
curl -X GET http://localhost:8080/1.0/identifiers/did:cheqd:mainnet:Ps1ysXP2Ae6GBfxNhNQNKN
curl -X GET http://localhost:8080/1.0/identifiers/did:com:1l6zglh8pvcrjtahsvds2qmfpn0hv83vn8f9cf3
curl -X GET http://localhost:8080/1.0/identifiers/did:kscirc:k12NqvVM9BX6AaMjPK1hUTUkKBWPBAUXAszTxdx7jDZPv4iqCZ1D
curl -X GET http://localhost:8080/1.0/identifiers/did:iscc:miagwptv4j2z57ci
curl -X GET http://localhost:8080/1.0/identifiers/did:ev:bmM8apgHQD8cPbwNsMSJKqkYRCDYhkK55uxR9
curl -X GET http://localhost:8080/1.0/identifiers/did:iid:3QUs61mk7a9CdCpckriQbA5emw8pubj6RMtHXP6gD66YbcungS6w2sa
curl -X GET http://localhost:8080/1.0/identifiers/did:evan:testcore:0x126E901F6F408f5E260d95c62E7c73D9B60fd734
curl -X GET http://localhost:8080/1.0/identifiers/did:bid:ef214PmkhKndUcArDQPgD5J4fFVwqJFPt
curl -X GET http://localhost:8080/1.0/identifiers/did:polygonid:polygon:amoy:2qZBvRQPTZwYEKDVT3xY8W8zXvznqykyeqjSmXdz4U
curl -X GET http://localhost:8080/1.0/identifiers/did:pdc:8801:0xf47b66bc0d9b7c73f9ff27bf1f49a2b69dc167fc
curl -X GET http://localhost:8080/1.0/identifiers/did:tys:4B4AbVzzcJSnCZsdX4VaKyQgHRnC
curl -X GET http://localhost:8080/1.0/identifiers/did:plc:yk4dd2qkboz2yv6tpubpc6co
curl -X GET http://localhost:8080/1.0/identifiers/did:evrc:issuer:ethereum:246d9b34-09e1-496e-ad5b-fb5ea889d96b
curl -X GET http://localhost:8080/1.0/identifiers/did:keri:EKYGGh-FtAphGmSZbsuBs_t4qpsjYJ2ZqvMKluq9OxmP
curl -X GET http://localhost:8080/1.0/identifiers/did:webs:peacekeeper.github.io:did-webs-iiw-tutorial:EKYGGh-FtAphGmSZbsuBs_t4qpsjYJ2ZqvMKluq9OxmP
curl -X GET http://localhost:8080/1.0/identifiers/did:content:3SqTXtoMpiPeNo5vEP2p7yNGQUeCGjqW1wnctv8yaCWXojD29GYcUEo
curl -X GET http://localhost:8080/1.0/identifiers/did:algo:426165491c77a6c95eeed8d0420b38b0afbe9057c4f33147eb90fafd32aaad22-591154170
curl -X GET http://localhost:8080/1.0/identifiers/did:itn:PA7xLNkMAqzzrDp4UBnrZm

You can also use an "Accept" header to request the DID document in a specific representation, e.g.:

curl -H "Accept: application/did+ld+json" https://dev.uniresolver.io/1.0/identifiers/did:sov:WRfXPg8dantKVubE3HX8pw
curl -H "Accept: application/did+json" https://dev.uniresolver.io/1.0/identifiers/did:sov:WRfXPg8dantKVubE3HX8pw
curl -H "Accept: application/did+cbor" https://dev.uniresolver.io/1.0/identifiers/did:sov:WRfXPg8dantKVubE3HX8pw

If this doesn't work, see Troubleshooting.

Note that there is also a Universal Resolver frontend that can optionally be installed separately.

It is possible to "deep link" to the resolution result of a specific DID as follows:

https://dev.uniresolver.io/#did:indy:sovrin:WRfXPg8dantKVubE3HX8pw

Drivers

Are you developing a DID method and Universal Resolver driver? Click Driver Development for instructions.

Driver Name	Driver Version	DID Method Spec Version	Docker Image or URL	Description
did-btcr	0.1-SNAPSHOT	0.1	universalresolver/driver-did-btcr	Bitcoin Reference
did-sov	0.1-SNAPSHOT	0.1	universalresolver/driver-did-sov	Sovrin public ledger
did-stack	0.1	1.0	universalresolver/driver-did-stack
did-dom	0.1-SNAPSHOT	(missing)	universalresolver/driver-did-dom
did-ethr	5.0.0	10.1.0	uport/uni-resolver-driver-did-uport	Ethereum addresses or secp256k1 publicKeys
did-ens	5.0.0	0.1.1	uport/uni-resolver-driver-did-uport	ENS names
did-web	5.0.0	3.0.0	uport/uni-resolver-driver-did-uport	Domain name
did-peer	5.0.0	1.0-draft	uport/uni-resolver-driver-did-uport	Peer DID
did-eosio	0.1.3	0.1	gimlyblockchain/eosio-universal-resolver-driver	EOSIO blockchain platform
did-v1	0.1	1.0	veresone/uni-resolver-did-v1-driver	Veres One Blockchain
did-jolo	0.1	0.1	jolocomgmbh/jolocom-did-driver	Jolocom identity management
did-hacera	0.1	(missing)	hacera/hacera-did-driver	HACERA autonomous data exchange network
did-elem	1.0.0	1.0		Sidetree protocol (Ethereum and IPFS)
did-seraphid	0.1	(missing)	swisscomblockchainag/seraph-id-did-driver	Seraph ID (SSI solution on the NEO blockchain platform)
did-github	0.1	(missing)		Github
did-ccp	0.1-SNAPSHOT	0.1	hello2mao/driver-did-ccp	Baidu Cloud
did-ont	0.1	1.0	ontio/ontid-driver	Ontology ONT ID
did-kilt	2.5.0	1.3	kiltprotocol/kilt-did-driver	KILT Protocol
did-factom	0.2.0-SNAPSHOT	1.0	sphereon/uni-resolver-driver-did-factom	Factom Protocol
did-key	1.0.0	0.7	universalresolver/driver-did-key	Public keys (in general)
did-io	0.1.0	(missing)	iotex/uni-resolver-driver-did-io	IoTeX Network
did-bba	0.2.2	1.0	blobaa/bba-did-driver	Blobaa blockchain-based authentication on the Ardor blockchain
did-schema	0.1.1	0.1	51nodes/schema-registry-did-resolver	Identify and address schema definitions in a schema registry
did-ion	0.8.1	0.1	identityfoundation/driver-did-ion	ION network (Sidetree implementation on top of Bitcoin)
did-ace	1.0	(missing)	aceblock/ace-did-driver	AceBlock blockchain framework
did-gatc	2.0.0	1.0 WD	gatacaid/universal-resolver-driver	GATACA (blockchain-agnostic digital identity platform)
did-icon-zzeung	0.1.2	1.0 WD	amuyu/driver-did-icon	ICON decentralized network
did-vaa	1.0.0	1.0 WD	caict/driver-did-vaa	BIF blockchain
did-unisot	1.0.0	1.0.0	unisot/unisot-did-driver	UNISOT distributed identity system (atop Bitcoin SV blockchain)
did-sol	3.3.0	3.3.0	identitydotcom/driver-did-sol	Solana blockchain
did-lit	0.1.1	0.1.1	ibct/driver-did-lit	LEDGIS blockchain
did-ebsi	2.0.0	2.0.0	URL	EBSI Platform (European Blockchain Services Infrastructure)
did-emtrust	0.1	0.1	halialabsdev/emtrust_did_driver	EmTrust WAI distributed identity system
did-meta	1.0	1.0	URL	Metadium Decentralized Identifiers
did-tz	0.1.0	0.1	ghcr.io/spruceid/didkit-http	Tezos DID method
did-pkh	0.0.1	0.1	ghcr.io/spruceid/didkit-http	Public Key Hash DID method
did-orb	v1.0.0-rc3	0.2	trustbloc/orb-did-driver	Orb DID method
did-oyd	0.4.5	0.4	oydeu/oydid-resolver	self-sustained environment for managing DIDs
did-moncon	0.4	0.3	camicasii/didresolver-g
did-dock	1.0.0	1.0 WD	0.1	docknetwork/dock-did-driver
did-mydata	1.3	1.1 WD	igrantio/uni-resolver-driver-did-mydata	iGrant.io
did-dns	0.1-SNAPSHOT	0.1	universalresolver/driver-did-dns	Domain name
did-indy	0.9.0	0.1	universalresolver/driver-did-indy	Hyperledger Indy
did-everscale	0.1	0.1	radianceteamssi/everscale-did-resolver-driver	Everscale Blockchain
did-alastria-mvp2	1.0.0	MVP2	alastria/universal-resolver	AlastriaID MVP2
did-cheqd	3.6.1	1.0	cheqd/did-resolver	cheqd network
did-com	1.0.0	1.0	ghcr.io/commercionetwork/uni-resolver-driver-did-com	Commercio public ledger
did-dyne	0.1	1.0	dyne/w3c-did-driver	Dyne.org Decentralized Identifiers
did-jwk	0.1	1.0	transmute/restricted-resolver	DID Json Web Key
did-kscirc	0.1	1.0	k4security/kschain-resolver	KSChain blockchain
did-iscc	0.1.0	0.1	ghcr.io/iscc/iscc-did-driver	International Standard Content Code - ISCC
did-ev	1.0.4	0.1	ghcr.io/kaytrust/driver-did-ev	KayTrust default method based on Ethereum smart contracts
did-iid	0.1.0	0.1	zoeyian/driver-did-iid:latest	Inspur DID Method
did-evan	0.1.2	0.9	evannetwork/evan-did-driver	evan.network
did-bid	2.0.0	2.0 WD	caictdevelop/driver-did-bid	BIF blockchain
did-polygonid	0.0.2	1.0.0	polygonid/driver-did-polygonid	PolygonID DID
did-pdc	0.0.1	(missing)	w744219971/driver-did-pdc	PDC DID
did-tys	1.0	1.0	itpeoplecorp/tys-did-driver	TYS DID
did-plc	0.0.1	dev	bnewbold/uni-resolver-driver-did-plc	PLC DID
did-evrc	1.0	1.0	viitorcloud/uni-resolver-driver-did-evrc	EveryCRED DID Method
did-keri	0.1	0.1	gleif/did-keri-resolver	KERI
did-webs	0.1	0.1	gleif/did-webs-resolver	KER, Web
did-content	0.1	0.1	kataru/content-did-driver	Content DID
did-algo	0.6.0	2.0	ghcr.io/aidtechnology/algoid-resolver	Algorand Blockchain DID Method
did-itn	1.0.0	1.0	ghcr.io/itn-trust/driver-did-itn	Integrated Trust Network (ITN) DID Method

More Information

• Driver Development
• Continuous Integration and Delivery
• Development System
• Branching Strategy
• Design Goals
• Troubleshooting
• Java Components

About

Decentralized Identity Foundation - https://identity.foundation/

Supported by NLnet and NGI0 PET, which is made possible with financial support from the European Commission's Next Generation Internet programme.