Comments

Threaded comments and review notes on policies.

Returns the list of user names which are present in the target policy and have access to the target document.

get

Returns the list of user names which are present in the target policy and have access to the target document.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation. Returns mix of broadcast target ("all"), role targets, and individual user targets with their roles.

application/json

labelstringRequired

Display name (username for users, role name for roles, "All" for broadcast)

Example: Administrator

valuestringRequired

Value to use when targeting (DID for users, role name for roles, "all" for broadcast)

Example: Administrator

typestring · enumRequired

Entry type: "all" = broadcast to everyone, "role" = target by role, "user" = target specific user

Example: rolePossible values:

rolesstring[]Optional

List of roles assigned to this user (only present when type = "user")

Example: ["Administrator"]

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

get/policy-comments/{policyId}/{documentId}/users

GET /api/v1/policy-comments/{policyId}/{documentId}/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "label": "All",
    "value": "all",
    "type": "all"
  },
  {
    "label": "Administrator",
    "value": "Administrator",
    "type": "role"
  },
  {
    "label": "Project_Proponent",
    "value": "Project_Proponent",
    "type": "role"
  },
  {
    "label": "ExampleUser",
    "value": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "roles": [
      "Document Owner",
      "Administrator"
    ],
    "type": "user"
  }
]

Returns the list of documents linked with the target document

get

Returns the list of documents linked with the target document

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

labelstringRequiredExample: Description

valuestringRequiredExample: 1773670900.819264517

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

get/policy-comments/{policyId}/{documentId}/relationships

GET /api/v1/policy-comments/{policyId}/{documentId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "label": "Parent VC Document",
    "value": "1773670900.819264517"
  }
]

Returns the list of schemas for the target document

get

Returns the list of schemas for the target document

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document 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

stringOptionalExample: innerSchemaConfigurationInText

contextone ofRequired

stringOptionalExample: jsonLdContextInText

readonlyboolean · nullableOptionalExample: false

systemboolean · nullableOptionalExample: false

activeboolean · nullableOptionalExample: false

codeVersionstring · nullableOptionalExample: 1.2.0

topicCountnumber · nullableOptionalExample: 1

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

get/policy-comments/{policyId}/{documentId}/schemas

GET /api/v1/policy-comments/{policyId}/{documentId}/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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": {}
  }
]

Returns the list of discussions for the target document

get

Returns the list of discussions for the target document

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Query parameters

searchstringOptional

Text

Example: Text

fieldstringOptional

Field path

Example: Field path

readonlybooleanOptional

When true and user has POLICIES_POLICY_AUDIT permission, enables audit mode — bypasses privacy filters and shows all discussions.

Example: false

Responses

200

Successful operation. Returns discussions linked to the document, filtered by privacy settings unless in audit mode.

application/json

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147

creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

targetstringOptionalExample: 1773670900.819264517

targetIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

messageIdstringOptionalExample: 1773670900.819264517

parentstringOptionalExample: 1773670900.819264517

hashstringOptional

namestringOptionalExample: Common

fieldstringOptionalExample: #150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1

fieldNamestringOptionalExample: Field name

relationshipsstring[]OptionalExample: ["1773670900.819264517"]

relationshipIdsstring[]OptionalExample: ["69aeb71ef8c5b278e3bab4e5"]

privacystring · enumOptionalExample: publicPossible values:

rolesstring[]Optional

usersstring[]Optional

systembooleanOptionalExample: true

countnumberOptional

Number of comments in this discussion

Example: 0

historyIdsstring[]Optional

Array of document IDs that form the history chain for this discussion target (added by API for GET /discussions)

Example: ["69aeb71ef8c5b278e3bab4e5"]

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

get/policy-comments/{policyId}/{documentId}/discussions

GET /api/v1/policy-comments/{policyId}/{documentId}/discussions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "target": "string",
    "targetId": "69aeb71ef8c5b278e3bab4e5",
    "messageId": "1773670900.819264517",
    "parent": "string",
    "hash": "QmExampleHash",
    "name": "Common",
    "field": "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1",
    "fieldName": "Field name",
    "relationships": [
      "1773670900.819264517"
    ],
    "relationshipIds": [
      "69aeb71ef8c5b278e3bab4e5"
    ],
    "privacy": "public",
    "roles": [
      "string"
    ],
    "users": [
      "string"
    ],
    "system": true,
    "count": 0,
    "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"
      }
    }
  }
]

Creates a new discussion linked to the target document

post

Creates a new discussion linked to the target document

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Body

namestringOptionalExample: Common

fieldstringOptionalExample: #150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1

fieldNamestringOptionalExample: Field name

parentstringOptionalExample: 1773670900.819264517

privacystring · enumOptionalExample: publicPossible values:

rolesstring[]Optional

usersstring[]Optional

relationshipsstring[]OptionalExample: ["1773670900.819264517"]

Responses

200

Successful operation.

application/json

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147

creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

targetstringOptionalExample: 1773670900.819264517

targetIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

messageIdstringOptionalExample: 1773670900.819264517

parentstringOptionalExample: 1773670900.819264517

hashstringOptional

namestringOptionalExample: Common

fieldstringOptionalExample: #150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1

fieldNamestringOptionalExample: Field name

relationshipsstring[]OptionalExample: ["1773670900.819264517"]

relationshipIdsstring[]OptionalExample: ["69aeb71ef8c5b278e3bab4e5"]

privacystring · enumOptionalExample: publicPossible values:

rolesstring[]Optional

usersstring[]Optional

systembooleanOptionalExample: true

countnumberOptional

Number of comments in this discussion

Example: 0

historyIdsstring[]Optional

Array of document IDs that form the history chain for this discussion target (added by API for GET /discussions)

Example: ["69aeb71ef8c5b278e3bab4e5"]

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post/policy-comments/{policyId}/{documentId}/discussions

POST /api/v1/policy-comments/{policyId}/{documentId}/discussions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "name": "Common",
  "field": "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1",
  "fieldName": "Field name",
  "privacy": "public"
}

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "target": "string",
  "targetId": "69aeb71ef8c5b278e3bab4e5",
  "messageId": "1773670900.819264517",
  "parent": "string",
  "hash": "QmExampleHash",
  "name": "Common",
  "field": "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1",
  "fieldName": "Field name",
  "relationships": [
    "1773670900.819264517"
  ],
  "relationshipIds": [
    "69aeb71ef8c5b278e3bab4e5"
  ],
  "privacy": "public",
  "roles": [
    "string"
  ],
  "users": [
    "string"
  ],
  "system": true,
  "count": 0,
  "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"
    }
  }
}

Creates a new message in the target discussion.

post

Creates a new message in the target discussion

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

discussionIdstringRequired

Discussion Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Body

anchorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

recipientsstring[]OptionalExample: ["did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599"]

fieldsstring[]OptionalExample: ["#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1"]

textstringOptionalExample: text

filesstring[]OptionalExample: ["text"]

Responses

200

Successful operation.

application/json

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147

creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

topicIdstringOptionalExample: 0.0.6046379

policyTopicIdstringOptionalExample: 0.0.6046379

policyInstanceTopicIdstringOptionalExample: 0.0.6046379

targetstringOptionalExample: 1773670900.819264517

targetIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

discussionMessageIdstringOptionalExample: 1773670900.819264517

discussionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5

messageIdstringOptionalExample: 1773670900.819264517

timestampstringOptionalExample: 1759493933458

hashstringOptional

senderstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

senderRolestringOptionalExample: Administrator

senderNamestringOptionalExample: StandardRegistry

recipientsstring[]OptionalExample: ["did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599"]

fieldsstring[]OptionalExample: ["#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1"]

textstringOptionalExample: text

isOwnerbooleanOptional

Whether the current user is the sender of this comment (added by API, not stored in DB)

Example: true

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

503

Block Unavailable.

application/json

post/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments

POST /api/v1/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "text": "This field needs review.",
  "fields": [
    "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1"
  ]
}

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "topicId": "0.0.6046379",
  "policyTopicId": "0.0.6046379",
  "policyInstanceTopicId": "0.0.6046379",
  "target": "string",
  "targetId": "69aeb71ef8c5b278e3bab4e5",
  "discussionMessageId": "1773670900.819264517",
  "discussionId": "69aeb71ef8c5b278e3bab4e5",
  "messageId": "1773670900.819264517",
  "timestamp": 1759493933458,
  "hash": "QmExampleHash",
  "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "senderRole": "Administrator",
  "senderName": "StandardRegistry",
  "recipients": [
    "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599"
  ],
  "fields": [
    "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1"
  ],
  "text": "text",
  "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"
    }
  }
}

Returns the list of messages for the target discussion

post

Returns the list of messages for the target discussion

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

discussionIdstringRequired

Discussion Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Query parameters

readonlybooleanOptional

When true and user has POLICIES_POLICY_AUDIT permission, enables audit mode — bypasses privacy filters.

Example: false

Body

searchstringOptional

Search text — matches against comment text, field name, sender name, or sender role

Example: text

fieldstringOptional

Filter by schema field path (e.g. "#schema-uuid&version/fieldName")

Example: #150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1

ltstringOptional

Cursor for pagination — return comments with _id less than this value (older comments)

Example: 69aeb71ef8c5b278e3bab4e5

gtstringOptional

Cursor for pagination — return comments with _id greater than this value (newer comments)

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/search

POST /api/v1/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "search": "review",
  "field": "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1"
}

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "topicId": "0.0.6046379",
    "policyTopicId": "0.0.6046379",
    "policyInstanceTopicId": "0.0.6046379",
    "target": "string",
    "targetId": "69aeb71ef8c5b278e3bab4e5",
    "discussionMessageId": "1773670900.819264517",
    "discussionId": "69aeb71ef8c5b278e3bab4e5",
    "messageId": "1773670900.819264517",
    "timestamp": 1759493933458,
    "hash": "QmExampleHash",
    "sender": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "senderRole": "Administrator",
    "senderName": "StandardRegistry",
    "recipients": [
      "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599"
    ],
    "fields": [
      "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1"
    ],
    "text": "text",
    "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"
      }
    }
  }
]

Returns the count of the messages in the target discussion

get

Returns the count of the messages in the target discussion

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

countnumberOptional

Number of comments in this discussion

Example: 0

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

503

Block Unavailable.

application/json

get/policy-comments/{policyId}/{documentId}/comments/count

GET /api/v1/policy-comments/{policyId}/{documentId}/comments/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fields": {
    "#150e3357-f6d2-4cd6-a69e-f9d911f8bbc7&1.0.0/field1.field1": 3,
    "#85c18385-e371-44ad-8155-57a834ba185a/projectTitle": 1
  },
  "count": 4
}

Encrypts and loads the file into IPFS linked to the target discussion

post

Encrypts and loads the file into IPFS linked to the target discussion

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

discussionIdstringRequired

Discussion Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Body

string · binaryOptional

Responses

201

Successful operation.

application/json

stringOptional

400

Bad request.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/file

POST /api/v1/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

"binary"

bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i

Retrieves and decrypts the file associated with the discussion from IPFS

get

Retrieves and decrypts the file associated with the discussion from IPFS

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

discussionIdstringRequired

Discussion Identifier

Example: 69aeb71ef8c5b278e3bab4e5

cidstringRequired

IPFS Content Identifier of the uploaded file

Example: bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i

Responses

200

Successful operation. Returns the decrypted file as binary stream.

application/json

string · binaryOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

File not found.

application/json

500

Internal server error.

application/json

get/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/file/{cid}

GET /api/v1/policy-comments/{policyId}/{documentId}/discussions/{discussionId}/comments/file/{cid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Returns the encryption key for the target document discussions.

get

Returns the encryption key as a binary file for decrypting discussion content linked to the target document. Optionally filter by specific discussion ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5

documentIdstringRequired

Document Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Query parameters

discussionIdstringOptional

Discussion Identifier

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

string · binaryOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Key file not found.

application/json

500

Internal server error.

application/json

get/policy-comments/{policyId}/{documentId}/keys

GET /api/v1/policy-comments/{policyId}/{documentId}/keys HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Last updated 11 hours ago