Wizard

Step-by-step guided policy creation workflow.

Creates a new policy.

post

Creates a new policy by wizard. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

rolesstring[]Required

schemasobject[]Required

trustChainobject[]Required

Responses

201

Successful operation. Returns the created policy ID and the wizard configuration used.

application/json

policyIdstringRequired

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/wizard/policy

HTTPcURLJavaScriptPython

POST /api/v1/wizard/policy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "roles": [
    "Project_Proponent",
    "VVB"
  ],
  "policy": {
    "name": "New Wizard Policy",
    "description": "Policy created by wizard",
    "topicDescription": "Wizard policy topic",
    "policyTag": "Tag_wizard_1773408686116"
  },
  "schemas": [],
  "trustChain": []
}

{
  "policyId": "69b411d8b23f3b6a77d12742",
  "wizardConfig": {
    "roles": [
      "Project_Proponent",
      "VVB"
    ],
    "policy": {
      "name": "New Wizard Policy",
      "description": "Policy created by wizard",
      "topicDescription": "Wizard policy topic",
      "policyTag": "Tag_wizard_1773408686116"
    },
    "schemas": [],
    "trustChain": []
  }
}

Creates a new policy.

post

Creates a new policy by wizard. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

saveStatebooleanRequired

Responses

202

Task accepted. Use the returned taskId to poll for the result.

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

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/wizard/push/policy

HTTPcURLJavaScriptPython

POST /api/v1/wizard/push/policy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "saveState": true,
  "wizardConfig": {
    "roles": [
      "Project_Proponent",
      "VVB"
    ],
    "policy": {
      "name": "New Wizard Policy",
      "description": "Policy created by wizard",
      "topicDescription": "Wizard policy topic",
      "policyTag": "Tag_wizard_1773408686116"
    },
    "schemas": [],
    "trustChain": []
  }
}

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

Get policy config.

post

Get policy config by wizard. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Database ID of the policy to get the wizard configuration for

Example: 69aeb71ef8c5b278e3bab4e5

Body

application/json

rolesstring[]Required

schemasobject[]Required

trustChainobject[]Required

Responses

200

Successful operation. Returns the policy config preview and the wizard configuration.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/wizard/{policyId}/config

HTTPcURLJavaScriptPython

POST /api/v1/wizard/{policyId}/config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "roles": [
    "Project_Proponent",
    "VVB"
  ],
  "policy": {
    "name": "New Wizard Policy",
    "description": "Policy created by wizard",
    "topicDescription": "Wizard policy topic",
    "policyTag": "Tag_wizard_1773408686116"
  },
  "schemas": [],
  "trustChain": []
}

{
  "policyConfig": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Policy name",
    "description": "Description",
    "topicDescription": "Description",
    "applicabilityConditions": "",
    "detailsUrl": "",
    "typicalProjects": "",
    "importantParameters": {
      "atValidation": "",
      "monitored": ""
    },
    "policyTag": "Tag",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "instanceTopicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "availability": "private",
    "codeVersion": "1.0.0",
    "tools": [
      {
        "name": "Tool 33",
        "version": "1.0.0",
        "topicId": "0.0.6046379",
        "messageId": "1773670900.819264517"
      }
    ],
    "createDate": "2026-03-03T17:25:53.312Z",
    "version": "1.0.0",
    "originalChanged": "text",
    "editableParametersSettings": [
      {}
    ],
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "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"
        ]
      }
    ],
    "policyDocumentation": [
      {
        "name": "create_device",
        "description": "Send event to create_device",
        "target": "create_device",
        "method": "POST",
        "alias": "monitoring-reports/create",
        "url": "/api/v1/policies/{policyId}/tag/create_device/blocks",
        "dmrvUrl": "/api/v1/dmrv/{policyId}/monitoring-reports/create"
      }
    ],
    "categories": [
      "text"
    ],
    "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": "text"
      }
    ],
    "ignoreRules": [
      {
        "code": "text",
        "blockType": "text",
        "property": "text",
        "contains": "text",
        "severity": "warning"
      }
    ]
  },
  "wizardConfig": {
    "roles": [
      "text"
    ],
    "policy": {
      "name": "text",
      "description": "text",
      "topicDescription": "text",
      "policyTag": "text"
    },
    "schemas": {
      "name": "text",
      "iri": "text",
      "isApproveEnable": true,
      "isMintSchema": true,
      "mintOptions": {
        "tokenId": "text",
        "rule": "text"
      },
      "dependencySchemaIri": "text",
      "relationshipsSchemaIri": "text",
      "initialRolesFor": [
        "text"
      ],
      "rolesConfig": [
        {
          "role": "text",
          "isApprover": true,
          "isCreator": true,
          "gridColumns": [
            {
              "field": "text",
              "title": "text"
            }
          ]
        }
      ]
    },
    "trustChain": {
      "role": "text",
      "mintSchemaIri": "text",
      "viewOnlyOwnDocuments": true
    }
  }
}