Skip to main content

Registries

The commands below read from the registries. Each accepts --contract-address <address>. If omitted, it defaults to the same environment variable as ledger write for that registry (for example DID_REGISTRY_CONTRACT_ADDRESS), so a variable set to choose a signing target also redirects reads. Pass --contract-address to override it for one call. contracts-registry has no write path and uses PROXY_FACTORY_CONTRACT_ADDRESS and PROXY_TEMPLATES_REGISTRY_CONTRACT_ADDRESS. Without option or variable, the default address of the API is used.

Each group also has an abi command that returns the ABI of its smart contract.

did-registry​

CommandDescription
did-registry identifiers listList DIDs. Filters: --controller, --verification-method-id, --verification-relationship
did-registry identifiers get <did> [--valid-at <date>]Resolve a DID document, optionally as of an ISO 8601 date
did-registry abiGet the contract ABI

--verification-relationship accepts authentication, assertionMethod, keyAgreement, capabilityInvocation or capabilityDelegation.

schemas-registry​

CommandDescription
schemas-registry schemas listList trusted schemas
schemas-registry schemas get <schemaId>Get a schema
schemas-registry schemas revisions <schemaId>List the revisions of a schema
schemas-registry schemas revision <schemaId> <revisionId>Get a revision of a schema
schemas-registry schemas metadata list <schemaId> <revisionId>List the metadata of a revision
schemas-registry schemas metadata get <schemaId> <revisionId> <metadataId>Get the metadata of a revision
schemas-registry abiGet the contract ABI

issuers-registry​

CommandDescription
issuers-registry issuers listList trusted issuers
issuers-registry issuers get <did>Get an issuer
issuers-registry issuers attributes list <did>List the attributes of an issuer
issuers-registry issuers attributes get <did> <attributeId>Get an attribute
issuers-registry issuers attributes revisions <did> <attributeId>List the revisions of an attribute
issuers-registry issuers attributes revision <did> <attributeId> <revisionId>Get a revision of an attribute
issuers-registry issuers proxies list <did>List the proxies of an issuer
issuers-registry issuers proxies get <did> <proxyId>Get a proxy
issuers-registry issuers proxies content <did> <proxyId> <path>Get a status list credential through a proxy
issuers-registry abiGet the contract ABI

policies-registry​

CommandDescription
policies-registry policies listList policies
policies-registry policies get <policyName>Get a policy, for example VerifiableAuthorisation
policies-registry subjects listList subjects with assigned policies
policies-registry subjects get <subject>Get a subject
policies-registry subjects policies <subject>List the policies assigned to a subject
policies-registry subjects policy <subject> <policyName>Get one policy assigned to a subject
policies-registry abiGet the contract ABI

timestamp​

CommandDescription
timestamp timestamps listList timestamps
timestamp timestamps get <timestampId>Get a timestamp
timestamp records listList records
timestamp records get <recordId>Get a record
timestamp records versions <recordId>List the versions of a record
timestamp records version <recordId> <versionId>Get a version of a record
timestamp hash-algorithms listList supported hash algorithms
timestamp hash-algorithms get <hashAlgorithmId>Get a hash algorithm
timestamp abiGet the contract ABI

track-and-trace​

CommandDescription
track-and-trace documents listList documents
track-and-trace documents get <documentId>Get a document
track-and-trace documents events <documentId>List the events of a document
track-and-trace documents event <documentId> <eventId>Get an event
track-and-trace documents accesses <documentId>List the accesses of a document
track-and-trace accesses get <subject>Get the access control entries of a subject DID
track-and-trace accesses check <creator>Check whether a DID is allowlisted as a document creator
track-and-trace abiGet the contract ABI

contracts-registry​

CommandDescription
contracts-registry contracts listList smart contracts
contracts-registry contracts get <address>Get a contract by address
contracts-registry templates listList contract templates
contracts-registry templates get <id>Get a contract template
contracts-registry abiGet the contract ABI