1 of 1

Resolve a DID

Resolve a DID to fetch the associated DID Documet

A user is able to input a DID (string) as a request format and resolve the DID to fetch the associated DID Document, DID Resolution Metadata and DID Document metadata.

Resolve a DID

Resolve a DID to fetch the associated DID Documet

A user is able to input a DID (string) as a request format and resolve the DID to fetch the associated DID Document, DID Resolution Metadata and DID Document metadata.

Resolve a DID Document.

Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the W3C DID Resolution specification.

GET/did/search/{did}

Path parameters

did*string

DID identifier to resolve.

Example: "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

Query parameters

metadataboolean

Return only metadata of DID Document instead of actual DID Document.

versionIdstring (uuid)

Unique UUID version identifier of DID Document. Allows for fetching a specific version of the DID Document. See cheqd DID Method Specification for more details.

Example: "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"

versionTimestring (date-time)

Returns the closest version of the DID Document at or before specified time. See DID Resolution handling for did:cheqd for more details.

Example: "1970-01-01T00:00:00Z"

transformKeysenum

This directive transforms the Verification Method key format from the version in the DID Document to the specified format chosen below.

Ed25519VerificationKey2018Ed25519VerificationKey2020JsonWebKey2020

servicestring

Query DID Document for a specific Service Endpoint by Service ID (e.g., service-1 in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1). This will typically redirect to the Service Endpoint based on DID Resolution specification algorithm.

Example: "service-1"

relativeRefstring

Relative reference is a query fragment appended to the Service Endpoint URL. Must be used along with the service query property above. See DID Resolution specification algorithm for more details.

Example: "/path/to/file"

Response

The request was successful.

Body

@contextstring

Example: "https://w3id.org/did-resolution/v1"

didDidResolutionMetadataDidResolutionMetadata (object)

contentTypeall of

Example: "application/did+ld+json"

ContentType (enum)

application/did+jsonapplication/did+ld+jsonapplication/ld+jsonapplication/json

retrievedstring

Example: "2021-09-01T12:00:00Z"

didDidProperties (object)

didStringstring

Example: "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"

methodstring

Example: "cheqd"

methodSpecificIdstring

Example: "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"

didDocumentDidDocument (object)

This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.

@contextarray of string

itemsstring

idstring

controllersarray of string

itemsstring

verificationMethodarray of VerificationMethod (object)

idstring

typestring

controllerstring

publicKeyMultibasestring

publicKeyJwkarray of string

itemsstring

servicearray of Service (object)

idstring

DID appended with Service fragment ID (e.g., #service-1 in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1)

Example: "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"

typestring

Service type as defined in DID Specification Registries.

Example: "LinkedDomains"

serviceEndpointarray of string

Service endpoint as defined in DID Core Specification.

itemsstring

Example: "https://example.com"

authenticationarray of string

itemsstring

assertionMethodarray of string

itemsstring

capabilityInvocationarray of string

itemsstring

capabilityDelegationarray of string

itemsstring

keyAgreementarray of string

itemsstring

didDocumentMetadataDidDocumentMetadata (object)

createdstring

Example: "2021-09-01T12:00:00Z"

deactivatedboolean

Example: false

updatedstring

Example: "2021-09-10T12:00:00Z"

versionIdstring

Example: "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"

linkedResourceMetadataarray of ResourceMetadata (object)

resourceURIstring

Example: "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b"

resourceCollectionIdstring

Example: "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"

resourceIdstring

Example: "398cee0a-efac-4643-9f4c-74c48c72a14b"

resourceNamestring

Example: "cheqd-issuer-logo"

resourceTypestring

Example: "CredentialArtwork"

mediaTypestring

Example: "image/png"

resourceVersionstring

Example: "1.0"

checksumstring

Example: "a95380f460e63ad939541a57aecbfd795fcd37c6d78ee86c885340e33a91b559"

createdstring

Example: "2021-09-01T12:00:00Z"

nextVersionIdstring

Example: "d4829ac7-4566-478c-a408-b44767eddadc"

previousVersionIdstring

Example: "ad7a8442-3531-46eb-a024-53953ec6e4ff"

Request

Response

Resolve a DID Document.

Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the W3C DID Resolution specification.

GET/did/search/{did}

Path parameters

did*string

DID identifier to resolve.

Example: "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"

Query parameters

metadataboolean

Return only metadata of DID Document instead of actual DID Document.

versionIdstring (uuid)

Unique UUID version identifier of DID Document. Allows for fetching a specific version of the DID Document. See cheqd DID Method Specification for more details.

Example: "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"

versionTimestring (date-time)

Returns the closest version of the DID Document at or before specified time. See DID Resolution handling for did:cheqd for more details.

Example: "1970-01-01T00:00:00Z"

transformKeysenum

This directive transforms the Verification Method key format from the version in the DID Document to the specified format chosen below.

Ed25519VerificationKey2018Ed25519VerificationKey2020JsonWebKey2020

servicestring

Example: "service-1"

relativeRefstring

Example: "/path/to/file"

Response

The request was successful.

Body

@contextstring

Example: "https://w3id.org/did-resolution/v1"

didDidResolutionMetadataDidResolutionMetadata (object)

contentTypeall of

Example: "application/did+ld+json"

ContentType (enum)

application/did+jsonapplication/did+ld+jsonapplication/ld+jsonapplication/json

retrievedstring

Example: "2021-09-01T12:00:00Z"

didDidProperties (object)

didStringstring

Example: "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"

methodstring

Example: "cheqd"

methodSpecificIdstring

Example: "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"

didDocumentDidDocument (object)

This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.

@contextarray of string

itemsstring

idstring

controllersarray of string

itemsstring

verificationMethodarray of VerificationMethod (object)

idstring

typestring

controllerstring

publicKeyMultibasestring

publicKeyJwkarray of string

itemsstring

servicearray of Service (object)

idstring

DID appended with Service fragment ID (e.g., #service-1 in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1)

Example: "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"

typestring

Service type as defined in DID Specification Registries.

Example: "LinkedDomains"

serviceEndpointarray of string

Service endpoint as defined in DID Core Specification.

itemsstring

Example: "https://example.com"

authenticationarray of string

itemsstring

assertionMethodarray of string

itemsstring

capabilityInvocationarray of string

itemsstring

capabilityDelegationarray of string

itemsstring

keyAgreementarray of string

itemsstring

didDocumentMetadataDidDocumentMetadata (object)

createdstring

Example: "2021-09-01T12:00:00Z"

deactivatedboolean

Example: false

updatedstring

Example: "2021-09-10T12:00:00Z"

versionIdstring

Example: "3ccde6ba-6ba5-56f2-9f4f-8825561a9860"

linkedResourceMetadataarray of ResourceMetadata (object)

resourceURIstring

Example: "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b"

resourceCollectionIdstring

Example: "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"

resourceIdstring

Example: "398cee0a-efac-4643-9f4c-74c48c72a14b"

resourceNamestring

Example: "cheqd-issuer-logo"

resourceTypestring

Example: "CredentialArtwork"

mediaTypestring

Example: "image/png"

resourceVersionstring

Example: "1.0"

checksumstring

Example: "a95380f460e63ad939541a57aecbfd795fcd37c6d78ee86c885340e33a91b559"

createdstring

Example: "2021-09-01T12:00:00Z"

nextVersionIdstring

Example: "d4829ac7-4566-478c-a408-b44767eddadc"

previousVersionIdstring

Example: "ad7a8442-3531-46eb-a024-53953ec6e4ff"

Request

Response

{
  "@context": "https://w3id.org/did-resolution/v1",
  "didDidResolutionMetadata": {
    "contentType": "application/did+ld+json",
    "retrieved": "2021-09-01T12:00:00Z",
    "did": {
      "didString": "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47",
      "method": "cheqd",
      "methodSpecificId": "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
    }
  },
  "didDocument": {
    "@context": [
      "https://www.w3.org/ns/did/v1"
    ],
    "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
    "controller": [
      "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
    ],
    "verificationMethod": [
      {
        "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1",
        "type": "Ed25519VerificationKey2018",
        "controller": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
        "publicKeyBase58": "z6MkkVbyHJLLjdjU5B62DaJ4mkdMdUkttf9UqySSkA9bVTeZ"
      }
    ],
    "authentication": [
      "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1"
    ],
    "service": [
      {
        "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1",
        "type": "LinkedDomains",
        "serviceEndpoint": [
          "https://example.com"
        ]
      }
    ]
  },
  "didDocumentMetadata": {
    "created": "2021-09-01T12:00:00Z",
    "deactivated": false,
    "updated": "2021-09-10T12:00:00Z",
    "versionId": "3ccde6ba-6ba5-56f2-9f4f-8825561a9860",
    "linkedResourceMetadata": [
      {
        "resourceURI": "did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b",
        "resourceCollectionId": "55dbc8bf-fba3-4117-855c-1e0dc1d3bb47",
        "resourceId": "398cee0a-efac-4643-9f4c-74c48c72a14b",
        "resourceName": "cheqd-issuer-logo",
        "resourceType": "CredentialArtwork",
        "mediaType": "image/png",
        "resourceVersion": "1.0",
        "checksum": "a95380f460e63ad939541a57aecbfd795fcd37c6d78ee86c885340e33a91b559",
        "created": "2021-09-01T12:00:00Z",
        "nextVersionId": "d4829ac7-4566-478c-a408-b44767eddadc",
        "previousVersionId": "ad7a8442-3531-46eb-a024-53953ec6e4ff"
      }
    ]
  }
}