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

Tags

User-defined tags for organizing platform resources.

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
POST /api/v1/tags HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 553

{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Tag label",
  "description": "Description",
  "owner": "DID",
  "date": "2026-03-03T17:25:53.312Z",
  "entity": "PolicyDocument",
  "status": "Published",
  "operation": "Create",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "uri": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "target": "1773670900.819264517",
  "localTarget": "69aeb71ef8c5b278e3bab4e5",
  "document": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tagSchemaId": "69aeb71ef8c5b278e3bab4e5",
  "inheritTags": false
}
{
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Credit Verification",
  "description": "Tag for verified carbon credit documents",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "date": "2026-03-03T17:25:53.312Z",
  "entity": "PolicyDocument",
  "status": "Published",
  "operation": "Create",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69b411d8b23f3b6a77d12742",
  "uri": "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i",
  "target": "1773670900.819264517",
  "localTarget": "69b411d8b23f3b6a77d12742",
  "document": {},
  "tagSchemaId": null,
  "inheritTags": false
}

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
200

Successful operation. Returns an object keyed by localTarget ID, where each value is a TagMapDTO with tags array.

application/json
post/tags/search
POST /api/v1/tags/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "entity": "PolicyDocument",
  "target": "1773670900.819264517"
}
{
  "69b83f18cd6b7c4adf4139bc": {
    "entity": "PolicyDocument",
    "target": "1773670900.819264517",
    "refreshDate": "2026-03-03T17:30:00.000Z",
    "tags": [
      {
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "name": "Carbon Credit Verification",
        "description": "Tag for verified carbon credit documents",
        "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "date": "2026-03-03T17:25:53.312Z",
        "entity": "PolicyDocument",
        "status": "Published",
        "operation": "Create",
        "topicId": "0.0.6046379",
        "messageId": "1773670900.819264517",
        "policyId": "69b411d8b23f3b6a77d12742",
        "target": "1773670900.819264517",
        "localTarget": "69b411d8b23f3b6a77d12742"
      }
    ]
  }
}

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
200

Successful operation.

application/json
booleanOptional
delete/tags/{uuid}
DELETE /api/v1/tags/{uuid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

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
200

Successful operation.

application/json
entitystring · enumRequiredExample: PolicyDocumentPossible values:
targetstringRequiredExample: 1773670900.819264517
refreshDatestringRequiredExample: 2026-03-03T17:25:53.312Z
post/tags/synchronization
POST /api/v1/tags/synchronization HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "entity": "PolicyDocument",
  "target": "1773670900.819264517"
}
{
  "entity": "PolicyDocument",
  "target": "1773670900.819264517",
  "refreshDate": "2026-03-03T17:30:00.000Z",
  "tags": [
    {
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "name": "Carbon Credit Verification",
      "description": "Tag for verified carbon credit documents",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "date": "2026-03-03T17:25:53.312Z",
      "entity": "PolicyDocument",
      "status": "Published",
      "operation": "Create",
      "topicId": "0.0.6046379",
      "messageId": "1773670900.819264517",
      "policyId": "69b411d8b23f3b6a77d12742",
      "target": "1773670900.819264517",
      "localTarget": "69b411d8b23f3b6a77d12742"
    }
  ]
}

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
200

Successful operation.

application/json
get/tags/schemas
GET /api/v1/tags/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Tag Schema",
    "description": "Schema for carbon credit verification tags",
    "entity": "TAG",
    "iri": "#tag-schema",
    "status": "PUBLISHED",
    "topicId": "0.0.6046379",
    "version": "1.0.0",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "messageId": "1773670900.819264517",
    "category": "TAG",
    "documentURL": "https://ipfs.io/ipfs/example",
    "contextURL": "https://ipfs.io/ipfs/example",
    "document": {},
    "context": {}
  }
]

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
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
POST /api/v1/tags/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 979

{
  "createDate": "2026-03-25T12:40:32.586Z",
  "updateDate": "2026-03-25T12:40:59.908Z",
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Schema name",
  "description": "Description",
  "entity": "POLICY",
  "iri": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "status": "DRAFT",
  "topicId": "0.0.6046379",
  "version": "1.0.0",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "messageId": "1773670900.819264517",
  "category": "POLICY",
  "templateId": "69aeb71ef8c5b278e3bab4e5",
  "templateSchemaId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "document": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "context": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "readonly": false,
  "system": false,
  "active": false,
  "codeVersion": "1.2.0",
  "topicCount": 1
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Tag Schema",
  "description": "Schema for carbon credit verification tags",
  "entity": "TAG",
  "iri": "#tag-schema",
  "status": "DRAFT",
  "topicId": "0.0.6046379",
  "version": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "messageId": "",
  "category": "TAG",
  "documentURL": "",
  "contextURL": "",
  "document": {},
  "context": {}
}

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
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
200

Successful operation.

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
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
put/tags/schemas/{schemaId}
PUT /api/v1/tags/schemas/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 979

{
  "createDate": "2026-03-25T12:40:32.586Z",
  "updateDate": "2026-03-25T12:40:59.908Z",
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Schema name",
  "description": "Description",
  "entity": "POLICY",
  "iri": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "status": "DRAFT",
  "topicId": "0.0.6046379",
  "version": "1.0.0",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "messageId": "1773670900.819264517",
  "category": "POLICY",
  "templateId": "69aeb71ef8c5b278e3bab4e5",
  "templateSchemaId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "document": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "context": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "readonly": false,
  "system": false,
  "active": false,
  "codeVersion": "1.2.0",
  "topicCount": 1
}
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Tag Schema",
    "description": "Schema for carbon credit verification tags",
    "entity": "TAG",
    "iri": "#tag-schema",
    "status": "PUBLISHED",
    "topicId": "0.0.6046379",
    "version": "1.0.0",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "messageId": "1773670900.819264517",
    "category": "TAG",
    "documentURL": "https://ipfs.io/ipfs/example",
    "contextURL": "https://ipfs.io/ipfs/example",
    "document": {},
    "context": {}
  }
]

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
200

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
delete/tags/schemas/{schemaId}
DELETE /api/v1/tags/schemas/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 0
}

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
200

Successful operation.

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
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
put/tags/schemas/{schemaId}/publish
PUT /api/v1/tags/schemas/{schemaId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Tag Schema",
    "description": "Schema for carbon credit verification tags",
    "entity": "TAG",
    "iri": "#tag-schema",
    "status": "PUBLISHED",
    "topicId": "0.0.6046379",
    "version": "1.0.0",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "messageId": "1773670900.819264517",
    "category": "TAG",
    "documentURL": "https://ipfs.io/ipfs/example",
    "contextURL": "https://ipfs.io/ipfs/example",
    "document": {},
    "context": {}
  }
]

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
200

Successful operation.

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
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
get/tags/schemas/published
GET /api/v1/tags/schemas/published HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Tag Schema",
    "description": "Schema for carbon credit verification tags",
    "entity": "TAG",
    "iri": "#tag-schema",
    "status": "PUBLISHED",
    "topicId": "0.0.6046379",
    "version": "1.0.0",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "messageId": "1773670900.819264517",
    "category": "TAG",
    "documentURL": "https://ipfs.io/ipfs/example",
    "contextURL": "https://ipfs.io/ipfs/example",
    "document": {},
    "context": {}
  }
]

Last updated