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

Labels

Labels for categorizing and filtering policies.

Return a list of all policy labels.

get

Returns all policy labels.

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
policyInstanceTopicIdstringOptional

Policy Instance Topic Id

Example: 0.0.6046379
Responses
200

Successful operation.

application/json
get/policy-labels
GET /api/v1/policy-labels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "name": "Carbon Label",
    "description": "Description",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "status": "DRAFT",
    "config": {}
  }
]

Creates a new policy label.

post

Creates a new policy label.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/policy-labels
POST /api/v1/policy-labels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "name": "Carbon Label",
  "description": "Label for carbon credits",
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Retrieves policy label.

get

Retrieves policy label for the specified ID.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
get/policy-labels/{definitionId}
GET /api/v1/policy-labels/{definitionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Updates policy label.

put

Updates policy label configuration for the specified label ID.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/policy-labels/{definitionId}
PUT /api/v1/policy-labels/{definitionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "Updated Carbon Label",
  "description": "Updated label description",
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Deletes the policy label.

delete

Deletes the policy label with the provided ID.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
booleanOptional
delete/policy-labels/{definitionId}
DELETE /api/v1/policy-labels/{definitionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Publishes policy label.

put

Publishes policy label for the specified label ID.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/policy-labels/{definitionId}/publish
PUT /api/v1/policy-labels/{definitionId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Publishes policy label.

put

Publishes policy label for the specified label ID.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
202

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/policy-labels/push/{definitionId}/publish
PUT /api/v1/policy-labels/push/{definitionId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Retrieves policy label relationships.

get

Retrieves policy label relationships for the specified ID.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/policy-labels/{definitionId}/relationships
GET /api/v1/policy-labels/{definitionId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "policy": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Policy name",
    "description": "Description",
    "topicDescription": "Description",
    "policyTag": "Tag",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "codeVersion": "1.0.0",
    "createDate": "2026-03-03T17:25:53.312Z",
    "version": "1.0.0",
    "originalChanged": true,
    "config": {},
    "userRole": "Installer",
    "userRoles": [
      "Installer"
    ],
    "userGroup": {
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    },
    "userGroups": [
      {
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "role": "Installer",
        "groupLabel": "Label",
        "groupName": "Name",
        "active": true
      }
    ],
    "policyRoles": [
      "Registrant"
    ],
    "policyNavigation": [
      {
        "role": "Registrant",
        "steps": [
          {
            "block": "Block tag",
            "level": 1,
            "name": "Step name"
          }
        ]
      }
    ],
    "policyTopics": [
      {
        "name": "Project",
        "description": "Project",
        "memoObj": "topic",
        "static": false,
        "type": "any"
      }
    ],
    "policyTokens": [
      {
        "tokenName": "Token name",
        "tokenSymbol": "Token symbol",
        "tokenType": "non-fungible",
        "decimals": "",
        "changeSupply": true,
        "enableAdmin": true,
        "enableFreeze": true,
        "enableKYC": true,
        "enableWipe": true,
        "templateTokenTag": "token_template_0"
      }
    ],
    "policyGroups": [
      {
        "name": "Group name",
        "creator": "Registrant",
        "groupAccessType": "Private",
        "groupRelationshipType": "Multiple",
        "members": [
          "Registrant"
        ]
      }
    ],
    "categories": [
      "string"
    ],
    "projectSchema": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "tests": [
      {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "name": "Test Name",
        "policyId": "69aeb71ef8c5b278e3bab4e5",
        "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "status": "NEW",
        "date": "2026-03-03T17:25:53.312Z",
        "duration": 0,
        "progress": 0,
        "resultId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "result": {}
      }
    ],
    "ignoreRules": [
      {
        "code": "string",
        "blockType": "string",
        "property": "string",
        "contains": "string",
        "severity": "warning"
      }
    ]
  },
  "policySchemas": [
    {
      "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",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "messageId": "1773670900.819264517",
      "category": "POLICY",
      "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "document": {},
      "context": {}
    }
  ],
  "documentsSchemas": [
    {
      "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",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "messageId": "1773670900.819264517",
      "category": "POLICY",
      "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "document": {},
      "context": {}
    }
  ]
}

Imports new labels from a zip file.

post

Imports new labels from the provided zip file into the local DB.

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

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
stringOptional
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/policy-labels/{policyId}/import/file
POST /api/v1/policy-labels/{policyId}/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Returns a zip file containing labels.

get

Returns a zip file containing labels.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation. Response zip file.

application/zip
string · binaryOptional
get/policy-labels/{definitionId}/export/file
GET /api/v1/policy-labels/{definitionId}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "result": "ok"
}

Imports a zip file containing labels.

post

Imports a zip file containing labels.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
stringOptional
Responses
200

policy label preview.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Carbon Label
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/policy-labels/import/file/preview
POST /api/v1/policy-labels/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Label",
  "description": "Description",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "status": "DRAFT",
  "config": {}
}

Search labels ans statistics.

post

Return a list of other labels ans statistics.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
textstringOptionalExample: Name
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
componentsstring · enumOptional

Component type

Example: allPossible values:
Responses
200

A list of labels ans statistics.

application/json
post/policy-labels/components
POST /api/v1/policy-labels/components HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "text": "Carbon",
  "components": "all"
}
{
  "statistics": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "name": "Carbon Label",
      "description": "Description",
      "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "topicId": "0.0.6046379",
      "messageId": "1773670900.819264517",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "policyTopicId": "0.0.6046379",
      "policyInstanceTopicId": "0.0.6046379",
      "status": "DRAFT",
      "config": {}
    }
  ],
  "labels": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "name": "Carbon Label",
      "description": "Description",
      "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "topicId": "0.0.6046379",
      "messageId": "1773670900.819264517",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "policyTopicId": "0.0.6046379",
      "policyInstanceTopicId": "0.0.6046379",
      "status": "DRAFT",
      "config": {}
    }
  ]
}

Return a list of all documents.

get

Returns all documents.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
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/policy-labels/{definitionId}/tokens
GET /api/v1/policy-labels/{definitionId}/tokens HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "hash": "GcDE9NsPJc7oCZvSVJySCZHxTxvjc3ZAMgtKozP1r1Eh",
    "signature": 0,
    "status": "NEW",
    "tag": "Block tag",
    "type": "Document type",
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "document": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": [
        "string"
      ],
      "credentialSubject": {},
      "issuer": {},
      "issuanceDate": "2026-03-03T17:25:53.312Z",
      "proof": {
        "type": "string",
        "created": "2026-03-03T17:25:53.312Z",
        "verificationMethod": "string",
        "proofPurpose": "string",
        "jws": "string"
      }
    }
  }
]

Return a list of all documents.

get

Returns all documents.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/policy-labels/{definitionId}/tokens/{documentId}
GET /api/v1/policy-labels/{definitionId}/tokens/{documentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "hash": "GcDE9NsPJc7oCZvSVJySCZHxTxvjc3ZAMgtKozP1r1Eh",
    "signature": 0,
    "status": "NEW",
    "tag": "Block tag",
    "type": "Document type",
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "document": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": [
        "string"
      ],
      "credentialSubject": {},
      "issuer": {},
      "issuanceDate": "2026-03-03T17:25:53.312Z",
      "proof": {
        "type": "string",
        "created": "2026-03-03T17:25:53.312Z",
        "verificationMethod": "string",
        "proofPurpose": "string",
        "jws": "string"
      }
    }
  }
]

Return a list of all label documents.

get

Returns all label documents.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
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/policy-labels/{definitionId}/documents
GET /api/v1/policy-labels/{definitionId}/documents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "definitionId": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "policyTopicId": "0.0.6046379",
    "policyInstanceTopicId": "0.0.6046379",
    "topicId": "0.0.6046379",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "messageId": "1773670900.819264517",
    "target": "string",
    "relationships": [
      "1773670900.819264517"
    ],
    "document": {}
  }
]

Creates a new label document.

post

Creates a new label document.

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

policy label Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
definitionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
topicIdstringOptionalExample: 0.0.6046379
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
targetstringOptionalExample: 1773670900.819264517
relationshipsstring[]OptionalExample: ["1773670900.819264517"]
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
definitionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
topicIdstringOptionalExample: 0.0.6046379
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
targetstringOptionalExample: 1773670900.819264517
relationshipsstring[]OptionalExample: ["1773670900.819264517"]
post/policy-labels/{definitionId}/documents
POST /api/v1/policy-labels/{definitionId}/documents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "definitionId": "69aeb71ef8c5b278e3bab4e5",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "target": "69aeb71ef8c5b278e3bab4e5",
  "document": {}
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "definitionId": "69aeb71ef8c5b278e3bab4e5",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "topicId": "0.0.6046379",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "messageId": "1773670900.819264517",
  "target": "string",
  "relationships": [
    "1773670900.819264517"
  ],
  "document": {}
}

Retrieves label document.

get

Retrieves label document for the specified ID.

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

Label Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
documentIdstringRequired

Label Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
definitionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
topicIdstringOptionalExample: 0.0.6046379
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
targetstringOptionalExample: 1773670900.819264517
relationshipsstring[]OptionalExample: ["1773670900.819264517"]
get/policy-labels/{definitionId}/documents/{documentId}
GET /api/v1/policy-labels/{definitionId}/documents/{documentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "definitionId": "69aeb71ef8c5b278e3bab4e5",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "topicId": "0.0.6046379",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "messageId": "1773670900.819264517",
  "target": "string",
  "relationships": [
    "1773670900.819264517"
  ],
  "document": {}
}

Retrieves documents relationships.

get

Retrieves documents relationships for the specified ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
documentIdstringRequired

Label Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/policy-labels/{definitionId}/documents/{documentId}/relationships
GET /api/v1/policy-labels/{definitionId}/documents/{documentId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "target": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "hash": "GcDE9NsPJc7oCZvSVJySCZHxTxvjc3ZAMgtKozP1r1Eh",
    "signature": 0,
    "status": "NEW",
    "tag": "Block tag",
    "type": "Document type",
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "document": [
      {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "type": [
          {}
        ],
        "verifiableCredential": [
          {}
        ],
        "proof": {
          "type": {},
          "created": {},
          "verificationMethod": {},
          "proofPurpose": {},
          "jws": {}
        }
      }
    ]
  },
  "relationships": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "hash": "GcDE9NsPJc7oCZvSVJySCZHxTxvjc3ZAMgtKozP1r1Eh",
      "signature": 0,
      "status": "NEW",
      "tag": "Block tag",
      "type": "Document type",
      "createDate": "2026-03-03T17:25:53.312Z",
      "updateDate": "2026-03-03T17:25:53.312Z",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "document": {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "type": [
          {}
        ],
        "credentialSubject": {},
        "issuer": {},
        "issuanceDate": "2026-03-03T17:25:53.312Z",
        "proof": {
          "type": {},
          "created": {},
          "verificationMethod": {},
          "proofPurpose": {},
          "jws": {}
        }
      }
    }
  ]
}

Last updated