Search DID-Linked Resource

Search and query for DID-Linked Resources

The /resource/search API allows users to search for specific entries of a Resource on the cheqd Network. For example, if there are multiple Resources associated with the same DID, the search functionality allows applications to make requests only to a specified Resource.

Last updated 10 months ago

Was this helpful?

Get a DID-Linked Resource.

get

This endpoint returns the DID-Linked Resource for a given DID identifier and resource identifier.

Authorizations

Path parameters

didstringrequired

DID identifier

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

Query parameters

resourceIdstring · uuidoptional

Fetch a DID-Linked Resource by Resource ID unique identifier. Since this is a unique identifier, other Resource query parameters are not required. See DID-Linked Resources for more details.

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

resourceNamestringoptional

Filter a DID-Linked Resource query by Resource Name. See DID-Linked Resources for more details.

Example: cheqd-issuer-logo

resourceTypestringoptional

Filter a DID-Linked Resource query by Resource Type. See DID-Linked Resources for more details.

Example: CredentialArtwork

resourceVersionstringoptional

Filter a DID-Linked Resource query by Resource Version, which is an optional free-text field used by issuers (e.g., "v1", "Final Version", "1st January 1970" etc). See DID-Linked Resources for more details.

Example: v1

resourceVersionTimestring · date-timeoptional

Filter a DID-Linked Resource query which returns the closest version of the Resource at or before specified time. See DID-Linked Resources for more details.

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

checksumstringoptional

Request integrity check against a given DID-Linked Resource by providing a SHA-256 checksum hash. See DID-Linked Resources for more details.

Example: dc64474d062ed750a66bad58cb609928de55ed0d81defd231a4a4bf97358e9ed

resourceMetadatabooleanoptional

Return only metadata of DID-Linked Resource instead of actual DID-Linked Resource. Mutually exclusive with some of the other parameters.

Responses

any

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/resource/search/{did}' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

401

500

{}

The request was successful.