For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tags

Creates new tag.

post

Creates new tag.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tag label
descriptionstringRequiredExample: Description
ownerstringRequiredExample: DID
datestringRequiredExample: 2026-03-03T17:25:53.312Z
entitystring · enumRequiredExample: PolicyDocumentPossible values:
statusstring · enumRequiredExample: PublishedPossible values:
operationstring · enumRequiredExample: CreatePossible values:
topicIdstringRequiredExample: 0.0.6046379
messageIdstringRequiredExample: 1773670900.819264517
policyIdstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uristringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
targetstringRequiredExample: 1773670900.819264517
localTargetstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
tagSchemaIdstringOptional

Tag schema database ID (for tags created with a tag schema)

Example: 69aeb71ef8c5b278e3bab4e5
inheritTagsbooleanOptional

Inherit tags

Example: false
Responses
201

Created tag.

application/json
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tag label
descriptionstringRequiredExample: Description
ownerstringRequiredExample: DID
datestringRequiredExample: 2026-03-03T17:25:53.312Z
entitystring · enumRequiredExample: PolicyDocumentPossible values:
statusstring · enumRequiredExample: PublishedPossible values:
operationstring · enumRequiredExample: CreatePossible values:
topicIdstringRequiredExample: 0.0.6046379
messageIdstringRequiredExample: 1773670900.819264517
policyIdstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uristringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
targetstringRequiredExample: 1773670900.819264517
localTargetstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
tagSchemaIdstringOptional

Tag schema database ID (for tags created with a tag schema)

Example: 69aeb71ef8c5b278e3bab4e5
inheritTagsbooleanOptional

Inherit tags

Example: false
post
/tags

Search tags.

post

Search tags.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
entitystring · enumRequiredExample: PolicyDocumentPossible values:
targetstringRequiredExample: 1773670900.819264517
targetsstring[]RequiredExample: 1773670900.819264517
linkedItemsstring[]RequiredExample: ["1773670900.819264517"]
Responses
post
/tags/search

Delete tag.

delete

Delete tag.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstringRequired

Tag identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
delete
/tags/{uuid}

Synchronization of tags with an external network.

post

Synchronization of tags with an external network.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
entitystring · enumRequiredExample: PolicyDocumentPossible values:
targetstringRequiredExample: 1773670900.819264517
targetsstring[]RequiredExample: 1773670900.819264517
linkedItemsstring[]RequiredExample: ["1773670900.819264517"]
Responses
post
/tags/synchronization

Return a list of all tag schemas.

get

Returns all tag schemas. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
get
/tags/schemas

Creates a new tag schema.

post

Creates a new tag schema. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
createDatestring · nullableOptionalExample: 2026-03-25T12:40:32.586Z
updateDatestring · nullableOptionalExample: 2026-03-25T12:40:59.908Z
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Schema name
descriptionstringRequiredExample: Description
entitystring · enumRequiredExample: POLICYPossible values:
iristringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
statusstring · enumRequiredExample: DRAFTPossible values:
topicIdstringRequiredExample: 0.0.6046379
versionstringRequiredExample: 1.0.0
creatorstring · nullableOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstring · nullableOptionalExample: 1773670900.819264517
categorystring · enumRequiredExample: POLICYPossible values:
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
topicCountnumber · nullableOptionalExample: 1
Responses
201

Created schema.

application/json
createDatestring · nullableOptionalExample: 2026-03-25T12:40:32.586Z
updateDatestring · nullableOptionalExample: 2026-03-25T12:40:59.908Z
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Schema name
descriptionstringRequiredExample: Description
entitystring · enumRequiredExample: POLICYPossible values:
iristringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
statusstring · enumRequiredExample: DRAFTPossible values:
topicIdstringRequiredExample: 0.0.6046379
versionstringRequiredExample: 1.0.0
creatorstring · nullableOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstring · nullableOptionalExample: 1773670900.819264517
categorystring · enumRequiredExample: POLICYPossible values:
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
topicCountnumber · nullableOptionalExample: 1
post
/tags/schemas

Updates schema configuration.

put

Updates schema configuration for the specified schema ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
createDatestring · nullableOptionalExample: 2026-03-25T12:40:32.586Z
updateDatestring · nullableOptionalExample: 2026-03-25T12:40:59.908Z
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Schema name
descriptionstringRequiredExample: Description
entitystring · enumRequiredExample: POLICYPossible values:
iristringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
statusstring · enumRequiredExample: DRAFTPossible values:
topicIdstringRequiredExample: 0.0.6046379
versionstringRequiredExample: 1.0.0
creatorstring · nullableOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstring · nullableOptionalExample: 1773670900.819264517
categorystring · enumRequiredExample: POLICYPossible values:
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
topicCountnumber · nullableOptionalExample: 1
Responses
put
/tags/schemas/{schemaId}

Deletes the schema.

delete

Deletes the schema with the provided schema ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
delete
/tags/schemas/{schemaId}

Publishes the schema.

put

Publishes the schema with the provided (internal) schema ID onto IPFS, sends a message featuring IPFS CID into the corresponding Hedera topic. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
put
/tags/schemas/{schemaId}/publish

Return a list of all published schemas.

get

Return a list of all published schemas. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/tags/schemas/published

Last updated