New Release
Guardian 3.7.0
Ctrlk
Release NotesCalendar
youtube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Repository

Policy marketplace for discovering and importing published policies.

Returns the list of users present in the policy.

get

Returns all users (grouped by DID) who have joined the specified policy, including their roles. The policy owner is always listed as "Administrator". Requires POLICIES_POLICY_AUDIT permission.

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

Database ID of the policy

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation. Returns array of users 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"]
get/policy-repository/{policyId}/users
GET /api/v1/policy-repository/{policyId}/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "label": "ExampleUser",
    "value": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "roles": [
      "Administrator"
    ],
    "type": "user"
  },
  {
    "label": "User1",
    "value": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
    "roles": [
      "Project_Proponent"
    ],
    "type": "user"
  }
]

Returns the list of published schemas in the target policy.

get

Returns only PUBLISHED schemas associated with the policy topic. Returns a subset of fields: uuid, name, version, iri, documentURL, contextURL. Requires POLICIES_POLICY_AUDIT permission.

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

Database ID of the policy

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
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
get/policy-repository/{policyId}/schemas
GET /api/v1/policy-repository/{policyId}/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "3eeb3f6b-da10-43fa-a247-a4df386278b5",
    "name": "6.2 Appendix 2: Project Risks Table",
    "version": "1.0.0",
    "iri": "#3eeb3f6b-da10-43fa-a247-a4df386278b5",
    "documentURL": "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i",
    "contextURL": "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
  }
]

Returns the list of documents in the target policy.

get

Returns paginated VC or VP documents from the policy. Only documents with a messageId (published to Hedera) are returned. Filter by type (VC or VP), owner DID, or schema IRI. Optionally load comment counts. Requires POLICIES_POLICY_AUDIT permission.

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

Database ID of the policy

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
typestring · enumOptional

Document type to filter by. If not VC or VP, returns empty array.

Possible values:
ownerstringOptional

Filter by document owner DID

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
schemastringOptional

Filter by document schema IRI

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

If true, includes comment count for each VC document

Responses
200

Successful operation. Returns documents and total count in X-Total-Count header.

application/json
get/policy-repository/{policyId}/documents
GET /api/v1/policy-repository/{policyId}/documents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-13T09:26:55.610Z",
    "updateDate": "2026-03-13T09:27:09.653Z",
    "hash": "74RwXshVfxSkWFkNhDWdHHMqHhAFMbZ6pR4sepB4pJz2",
    "hederaStatus": "ISSUE",
    "signature": 0,
    "type": "STANDARD_REGISTRY",
    "option": {
      "status": "NEW"
    },
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.8200599",
    "messageId": "1773394029.513409000",
    "document": {
      "id": "urn:uuid:962aa166-7da1-4fab-ad88-6681ac55f770",
      "type": [
        "VerifiableCredential"
      ],
      "issuer": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "issuanceDate": "2026-03-13T09:26:55.502Z",
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
      ],
      "credentialSubject": [
        {
          "OrganizationName": "Organization name",
          "Website": "https://google.com",
          "Tags": "Tag",
          "@context": [
            "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
          ],
          "id": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
          "type": "StandardRegistry"
        }
      ],
      "proof": {
        "type": "Ed25519Signature2018",
        "created": "2026-03-13T09:26:55Z",
        "verificationMethod": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599#did-root-key",
        "proofPurpose": "assertionMethod",
        "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Uc6RaUnv_zC4xc9j3mBqdd8Ew3z6lZITofdoJUYpxDot-fZhQEtiDjPAj5Au6UwApAfTnXy_el-uv5iOdzOyCg"
      }
    },
    "documentFileId": "69b3d86d0b1c848021821bf9",
    "tableFileIds": [],
    "id": "69b3d85f0b1c848021821bf2"
  }
]
PreviousComments
NextSuggestions

Last updated

Was this helpful?