Resolve a DID
Roles
Analytics Events
/v1/dids/{id}Retrieves a DID and its metadata from the tenant by its URI. This may involve a network call depending on the method involved:
- For did:key the public key is encapsulated in the DID URI itself.
- For did:web it must be resolved by accessing the
/.well-known/did.jsonpath on its domain.
Analytic events
- DID_RETRIEVE_START
- DID_RETRIEVE_SUCCESS
- DID_RETRIEVE_FAIL
Authorization
bearerAuth In: header
Path Parameters
DID
didResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/dids/string"{ "did": "did:web:learn.vii.au01.mattr.global", "registrationStatus": "COMPLETED", "localMetadata": { "keys": [ { "didDocumentKeyId": "did:web:learn.vii.au01.mattr.global#z12KiP7r", "kmsKeyId": "96fa6a94-a8cf-4afd-825b-70b46bdb60ee" }, { "didDocumentKeyId": "did:web:learn.vii.au01.mattr.global#nCxqyzxHFi", "kmsKeyId": "378dfe87-6eba-4779-a402-34ff5b267840" }, { "didDocumentKeyId": "did:web:learn.vii.au01.mattr.global#2vcj3MjR4d", "kmsKeyId": "a0cba537-ffe1-486d-aedd-6ead80e75519" }, { "didDocumentKeyId": "did:web:learn.vii.au01.mattr.global#CU6dJt9p8t", "kmsKeyId": "250c4e1f-bae3-44ca-9f4e-4f7ff15851e2" } ], "registered": 1674421454614, "initialDidDocument": { "@context": [ "https://w3.org/ns/did/v1", "https://w3id.org/security/suites/x25519-2019/v1", "https://w3id.org/security/suites/jws-2020/v1", "https://w3id.org/security/suites/ed25519-2018/v1", "https://w3id.org/security/bbs/v1" ], "id": "did:web:learn.vii.au01.mattr.global", "verificationMethod": [ { "id": "did:web:learn.vii.au01.mattr.global#z12KiP7r", "controller": "did:web:learn.vii.au01.mattr.global", "type": "JsonWebKey2020", "publicKeyJwk": { "kty": "EC", "crv": "P-256", "x": "PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w", "y": "7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI" } }, { "id": "did:web:learn.vii.au01.mattr.global#2vcj3MjR4d", "controller": "did:web:learn.vii.au01.mattr.global", "type": "Ed25519VerificationKey2018", "publicKeyBase58": "2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24" }, { "id": "did:web:learn.vii.au01.mattr.global#nCxqyzxHFi", "controller": "did:web:learn.vii.au01.mattr.global", "type": "Bls12381G2Key2020", "publicKeyBase58": "nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB" } ], "authentication": [ "did:web:learn.vii.au01.mattr.global#2vcj3MjR4d" ], "assertionMethod": [ "did:web:learn.vii.au01.mattr.global#z12KiP7r", "did:web:learn.vii.au01.mattr.global#2vcj3MjR4d", "did:web:learn.vii.au01.mattr.global#nCxqyzxHFi" ], "capabilityDelegation": [ "did:web:learn.vii.au01.mattr.global#z12KiP7r", "did:web:learn.vii.au01.mattr.global#2vcj3MjR4d", "did:web:learn.vii.au01.mattr.global#nCxqyzxHFi" ], "capabilityInvocation": [ "did:web:learn.vii.au01.mattr.global#z12KiP7r", "did:web:learn.vii.au01.mattr.global#2vcj3MjR4d", "did:web:learn.vii.au01.mattr.global#nCxqyzxHFi" ], "keyAgreement": [ { "id": "did:web:learn.vii.au01.mattr.global#CU6dJt9p8t", "controller": "did:web:learn.vii.au01.mattr.global", "type": "X25519KeyAgreementKey2019", "publicKeyBase58": "CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7" } ] } }}How would you rate this page?
Retrieve a list of DIDs GET
Returns a list of all DIDs (Decentralized Identifiers) managed by the tenant and their associated meta-data. ### **Analytic events** * DID_RETRIEVE_LIST_START * DID_RETRIEVE_LIST_SUCCESS * DID_RETRIEVE_LIST_FAIL
Delete a DID DELETE
Deletes a DID and all associated metadata by providing its URI. This includes all the removal of all associated private keys from the Key Management System (KMS). <Callout> For `did:web` you will need to manually remove the `did.json` from your hosted domain. </Callout> ### **Analytic events** * DID_DELETE_START * DID_DELETE_SUCCESS * DID_DELETE_FAIL