Accounts

Returns current session of the user.

get

Returns current user session.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

usernamestringRequiredExample: StandardRegistry

didstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

hederaAccountIdstringOptionalExample: 0.0.6046379

rolestringRequiredExample: STANDARD_REGISTRY

permissionsstring[]RequiredExample: ["ACCOUNTS_STANDARD_REGISTRY_READ","DEMO_KEY_CREATE","IPFS_FILE_READ","IPFS_FILE_CREATE","PROFILES_USER_READ","PROFILES_USER_UPDATE","PROFILES_BALANCE_READ","ACCOUNTS_ACCOUNT_READ","ANALYTIC_POLICY_READ","ANALYTIC_MODULE_READ","ANALYTIC_TOOL_READ","ANALYTIC_SCHEMA_READ","ANALYTIC_DOCUMENT_READ","ARTIFACTS_FILE_READ","ARTIFACTS_FILE_CREATE","ARTIFACTS_FILE_DELETE","BRANDING_CONFIG_UPDATE","CONTRACTS_CONTRACT_READ","CONTRACTS_CONTRACT_CREATE","CONTRACTS_CONTRACT_DELETE","CONTRACTS_CONTRACT_MANAGE","CONTRACTS_WIPE_REQUEST_READ","CONTRACTS_WIPE_REQUEST_UPDATE","CONTRACTS_WIPE_REQUEST_DELETE","CONTRACTS_WIPE_REQUEST_REVIEW","CONTRACTS_WIPE_ADMIN_CREATE","CONTRACTS_WIPE_ADMIN_DELETE","CONTRACTS_WIPE_MANAGER_CREATE","CONTRACTS_WIPE_MANAGER_DELETE","CONTRACTS_WIPER_CREATE","CONTRACTS_WIPER_DELETE","CONTRACTS_POOL_READ","CONTRACTS_POOL_UPDATE","CONTRACTS_POOL_DELETE","CONTRACTS_RETIRE_REQUEST_READ","CONTRACTS_RETIRE_REQUEST_CREATE","CONTRACTS_RETIRE_REQUEST_DELETE","CONTRACTS_RETIRE_REQUEST_REVIEW","CONTRACTS_RETIRE_ADMIN_CREATE","CONTRACTS_RETIRE_ADMIN_DELETE","CONTRACTS_PERMISSIONS_READ","CONTRACTS_DOCUMENT_READ","LOG_LOG_READ","MODULES_MODULE_READ","MODULES_MODULE_CREATE","MODULES_MODULE_UPDATE","MODULES_MODULE_DELETE","MODULES_MODULE_REVIEW","POLICIES_POLICY_READ","POLICIES_POLICY_CREATE","POLICIES_POLICY_UPDATE","POLICIES_POLICY_DELETE","POLICIES_POLICY_REVIEW","POLICIES_POLICY_EXECUTE","POLICIES_POLICY_MANAGE","POLICIES_MIGRATION_CREATE","POLICIES_RECORD_ALL","SCHEMAS_SCHEMA_READ","SCHEMAS_SCHEMA_CREATE","SCHEMAS_SCHEMA_UPDATE","SCHEMAS_SCHEMA_DELETE","SCHEMAS_SCHEMA_REVIEW","SCHEMAS_SYSTEM_SCHEMA_READ","SCHEMAS_SYSTEM_SCHEMA_CREATE","SCHEMAS_SYSTEM_SCHEMA_UPDATE","SCHEMAS_SYSTEM_SCHEMA_DELETE","SCHEMAS_SYSTEM_SCHEMA_REVIEW","TOOLS_TOOL_READ","TOOLS_TOOL_CREATE","TOOLS_TOOL_UPDATE","TOOLS_TOOL_DELETE","TOOLS_TOOL_REVIEW","TOOL_MIGRATION_CREATE","TOKENS_TOKEN_READ","TOKENS_TOKEN_CREATE","TOKENS_TOKEN_UPDATE","TOKENS_TOKEN_DELETE","TOKENS_TOKEN_MANAGE","TAGS_TAG_READ","TAGS_TAG_CREATE","PROFILES_RESTORE_ALL","SUGGESTIONS_SUGGESTIONS_READ","SUGGESTIONS_SUGGESTIONS_UPDATE","SETTINGS_SETTINGS_READ","SETTINGS_SETTINGS_UPDATE","SETTINGS_THEME_READ","SETTINGS_THEME_CREATE","SETTINGS_THEME_UPDATE","SETTINGS_THEME_DELETE","PERMISSIONS_ROLE_READ","PERMISSIONS_ROLE_CREATE","PERMISSIONS_ROLE_UPDATE","PERMISSIONS_ROLE_DELETE","PERMISSIONS_ROLE_MANAGE","ACCESS_POLICY_ALL","SCHEMAS_RULE_CREATE","SCHEMAS_RULE_READ","SCHEMAS_RULE_EXECUTE","FORMULAS_FORMULA_CREATE","FORMULAS_FORMULA_READ","POLICIES_EXTERNAL_POLICY_READ","POLICIES_EXTERNAL_POLICY_CREATE","POLICIES_EXTERNAL_POLICY_UPDATE","POLICIES_EXTERNAL_POLICY_DELETE","LOG_LOG_READ","LOG_SYSTEM_READ"]

locationstringOptionalExample: local

500

Internal server error.

application/json

get

/accounts/session

HTTPcURLJavaScriptPython

GET /api/v1/accounts/session HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "username": "StandardRegistry",
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "hederaAccountId": "0.0.6046379",
  "role": "STANDARD_REGISTRY",
  "permissions": [
    "ACCOUNTS_STANDARD_REGISTRY_READ",
    "DEMO_KEY_CREATE",
    "IPFS_FILE_READ",
    "IPFS_FILE_CREATE",
    "PROFILES_USER_READ",
    "PROFILES_USER_UPDATE",
    "PROFILES_BALANCE_READ",
    "ACCOUNTS_ACCOUNT_READ",
    "ANALYTIC_POLICY_READ",
    "ANALYTIC_MODULE_READ",
    "ANALYTIC_TOOL_READ",
    "ANALYTIC_SCHEMA_READ",
    "ANALYTIC_DOCUMENT_READ",
    "ARTIFACTS_FILE_READ",
    "ARTIFACTS_FILE_CREATE",
    "ARTIFACTS_FILE_DELETE",
    "BRANDING_CONFIG_UPDATE",
    "CONTRACTS_CONTRACT_READ",
    "CONTRACTS_CONTRACT_CREATE",
    "CONTRACTS_CONTRACT_DELETE",
    "CONTRACTS_CONTRACT_MANAGE",
    "CONTRACTS_WIPE_REQUEST_READ",
    "CONTRACTS_WIPE_REQUEST_UPDATE",
    "CONTRACTS_WIPE_REQUEST_DELETE",
    "CONTRACTS_WIPE_REQUEST_REVIEW",
    "CONTRACTS_WIPE_ADMIN_CREATE",
    "CONTRACTS_WIPE_ADMIN_DELETE",
    "CONTRACTS_WIPE_MANAGER_CREATE",
    "CONTRACTS_WIPE_MANAGER_DELETE",
    "CONTRACTS_WIPER_CREATE",
    "CONTRACTS_WIPER_DELETE",
    "CONTRACTS_POOL_READ",
    "CONTRACTS_POOL_UPDATE",
    "CONTRACTS_POOL_DELETE",
    "CONTRACTS_RETIRE_REQUEST_READ",
    "CONTRACTS_RETIRE_REQUEST_CREATE",
    "CONTRACTS_RETIRE_REQUEST_DELETE",
    "CONTRACTS_RETIRE_REQUEST_REVIEW",
    "CONTRACTS_RETIRE_ADMIN_CREATE",
    "CONTRACTS_RETIRE_ADMIN_DELETE",
    "CONTRACTS_PERMISSIONS_READ",
    "CONTRACTS_DOCUMENT_READ",
    "LOG_LOG_READ",
    "MODULES_MODULE_READ",
    "MODULES_MODULE_CREATE",
    "MODULES_MODULE_UPDATE",
    "MODULES_MODULE_DELETE",
    "MODULES_MODULE_REVIEW",
    "POLICIES_POLICY_READ",
    "POLICIES_POLICY_CREATE",
    "POLICIES_POLICY_UPDATE",
    "POLICIES_POLICY_DELETE",
    "POLICIES_POLICY_REVIEW",
    "POLICIES_POLICY_EXECUTE",
    "POLICIES_POLICY_MANAGE",
    "POLICIES_MIGRATION_CREATE",
    "POLICIES_RECORD_ALL",
    "SCHEMAS_SCHEMA_READ",
    "SCHEMAS_SCHEMA_CREATE",
    "SCHEMAS_SCHEMA_UPDATE",
    "SCHEMAS_SCHEMA_DELETE",
    "SCHEMAS_SCHEMA_REVIEW",
    "SCHEMAS_SYSTEM_SCHEMA_READ",
    "SCHEMAS_SYSTEM_SCHEMA_CREATE",
    "SCHEMAS_SYSTEM_SCHEMA_UPDATE",
    "SCHEMAS_SYSTEM_SCHEMA_DELETE",
    "SCHEMAS_SYSTEM_SCHEMA_REVIEW",
    "TOOLS_TOOL_READ",
    "TOOLS_TOOL_CREATE",
    "TOOLS_TOOL_UPDATE",
    "TOOLS_TOOL_DELETE",
    "TOOLS_TOOL_REVIEW",
    "TOOL_MIGRATION_CREATE",
    "TOKENS_TOKEN_READ",
    "TOKENS_TOKEN_CREATE",
    "TOKENS_TOKEN_UPDATE",
    "TOKENS_TOKEN_DELETE",
    "TOKENS_TOKEN_MANAGE",
    "TAGS_TAG_READ",
    "TAGS_TAG_CREATE",
    "PROFILES_RESTORE_ALL",
    "SUGGESTIONS_SUGGESTIONS_READ",
    "SUGGESTIONS_SUGGESTIONS_UPDATE",
    "SETTINGS_SETTINGS_READ",
    "SETTINGS_SETTINGS_UPDATE",
    "SETTINGS_THEME_READ",
    "SETTINGS_THEME_CREATE",
    "SETTINGS_THEME_UPDATE",
    "SETTINGS_THEME_DELETE",
    "PERMISSIONS_ROLE_READ",
    "PERMISSIONS_ROLE_CREATE",
    "PERMISSIONS_ROLE_UPDATE",
    "PERMISSIONS_ROLE_DELETE",
    "PERMISSIONS_ROLE_MANAGE",
    "ACCESS_POLICY_ALL",
    "SCHEMAS_RULE_CREATE",
    "SCHEMAS_RULE_READ",
    "SCHEMAS_RULE_EXECUTE",
    "FORMULAS_FORMULA_CREATE",
    "FORMULAS_FORMULA_READ",
    "POLICIES_EXTERNAL_POLICY_READ",
    "POLICIES_EXTERNAL_POLICY_CREATE",
    "POLICIES_EXTERNAL_POLICY_UPDATE",
    "POLICIES_EXTERNAL_POLICY_DELETE",
    "LOG_LOG_READ",
    "LOG_SYSTEM_READ"
  ],
  "location": "local"
}

Registers a new user account.

post

Object that contain username, password and role fields.

Body

application/json

usernamestringRequiredExample: NewStandardRegistry

passwordstringRequiredExample: StrongPassword3#

password_confirmationstringRequiredExample: StrongPassword3#

rolestringRequiredExample: STANDARD_REGISTRY

Responses

201

Successful operation.

application/json

409

Conflict.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/accounts/register

HTTPcURLJavaScriptPython

POST /api/v1/accounts/register HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "username": "StandardRegistry",
  "password": "StrongPassword3#",
  "password_confirmation": "StrongPassword3#",
  "role": "STANDARD_REGISTRY"
}

{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "username": "StandardRegistry",
  "role": "STANDARD_REGISTRY",
  "permissions": [
    "ACCOUNTS_STANDARD_REGISTRY_READ",
    "DEMO_KEY_CREATE",
    "IPFS_FILE_READ",
    "IPFS_FILE_CREATE",
    "PROFILES_USER_READ",
    "PROFILES_USER_UPDATE",
    "PROFILES_BALANCE_READ",
    "ACCOUNTS_ACCOUNT_READ",
    "ANALYTIC_POLICY_READ",
    "ANALYTIC_MODULE_READ",
    "ANALYTIC_TOOL_READ",
    "ANALYTIC_SCHEMA_READ",
    "ANALYTIC_DOCUMENT_READ",
    "ARTIFACTS_FILE_READ",
    "ARTIFACTS_FILE_CREATE",
    "ARTIFACTS_FILE_DELETE",
    "BRANDING_CONFIG_UPDATE",
    "CONTRACTS_CONTRACT_READ",
    "CONTRACTS_CONTRACT_CREATE",
    "CONTRACTS_CONTRACT_DELETE",
    "CONTRACTS_CONTRACT_MANAGE",
    "CONTRACTS_WIPE_REQUEST_READ",
    "CONTRACTS_WIPE_REQUEST_UPDATE",
    "CONTRACTS_WIPE_REQUEST_DELETE",
    "CONTRACTS_WIPE_REQUEST_REVIEW",
    "CONTRACTS_WIPE_ADMIN_CREATE",
    "CONTRACTS_WIPE_ADMIN_DELETE",
    "CONTRACTS_WIPE_MANAGER_CREATE",
    "CONTRACTS_WIPE_MANAGER_DELETE",
    "CONTRACTS_WIPER_CREATE",
    "CONTRACTS_WIPER_DELETE",
    "CONTRACTS_POOL_READ",
    "CONTRACTS_POOL_UPDATE",
    "CONTRACTS_POOL_DELETE",
    "CONTRACTS_RETIRE_REQUEST_READ",
    "CONTRACTS_RETIRE_REQUEST_CREATE",
    "CONTRACTS_RETIRE_REQUEST_DELETE",
    "CONTRACTS_RETIRE_REQUEST_REVIEW",
    "CONTRACTS_RETIRE_ADMIN_CREATE",
    "CONTRACTS_RETIRE_ADMIN_DELETE",
    "CONTRACTS_PERMISSIONS_READ",
    "CONTRACTS_DOCUMENT_READ",
    "LOG_LOG_READ",
    "MODULES_MODULE_READ",
    "MODULES_MODULE_CREATE",
    "MODULES_MODULE_UPDATE",
    "MODULES_MODULE_DELETE",
    "MODULES_MODULE_REVIEW",
    "POLICIES_POLICY_READ",
    "POLICIES_POLICY_CREATE",
    "POLICIES_POLICY_UPDATE",
    "POLICIES_POLICY_DELETE",
    "POLICIES_POLICY_REVIEW",
    "POLICIES_POLICY_EXECUTE",
    "POLICIES_POLICY_MANAGE",
    "POLICIES_MIGRATION_CREATE",
    "POLICIES_RECORD_ALL",
    "SCHEMAS_SCHEMA_READ",
    "SCHEMAS_SCHEMA_CREATE",
    "SCHEMAS_SCHEMA_UPDATE",
    "SCHEMAS_SCHEMA_DELETE",
    "SCHEMAS_SCHEMA_REVIEW",
    "SCHEMAS_SYSTEM_SCHEMA_READ",
    "SCHEMAS_SYSTEM_SCHEMA_CREATE",
    "SCHEMAS_SYSTEM_SCHEMA_UPDATE",
    "SCHEMAS_SYSTEM_SCHEMA_DELETE",
    "SCHEMAS_SYSTEM_SCHEMA_REVIEW",
    "TOOLS_TOOL_READ",
    "TOOLS_TOOL_CREATE",
    "TOOLS_TOOL_UPDATE",
    "TOOLS_TOOL_DELETE",
    "TOOLS_TOOL_REVIEW",
    "TOOL_MIGRATION_CREATE",
    "TOKENS_TOKEN_READ",
    "TOKENS_TOKEN_CREATE",
    "TOKENS_TOKEN_UPDATE",
    "TOKENS_TOKEN_DELETE",
    "TOKENS_TOKEN_MANAGE",
    "TAGS_TAG_READ",
    "TAGS_TAG_CREATE",
    "PROFILES_RESTORE_ALL",
    "SUGGESTIONS_SUGGESTIONS_READ",
    "SUGGESTIONS_SUGGESTIONS_UPDATE",
    "SETTINGS_SETTINGS_READ",
    "SETTINGS_SETTINGS_UPDATE",
    "SETTINGS_THEME_READ",
    "SETTINGS_THEME_CREATE",
    "SETTINGS_THEME_UPDATE",
    "SETTINGS_THEME_DELETE",
    "PERMISSIONS_ROLE_READ",
    "PERMISSIONS_ROLE_CREATE",
    "PERMISSIONS_ROLE_UPDATE",
    "PERMISSIONS_ROLE_DELETE",
    "PERMISSIONS_ROLE_MANAGE",
    "ACCESS_POLICY_ALL",
    "SCHEMAS_RULE_CREATE",
    "SCHEMAS_RULE_READ",
    "SCHEMAS_RULE_EXECUTE",
    "FORMULAS_FORMULA_CREATE",
    "FORMULAS_FORMULA_READ",
    "POLICIES_EXTERNAL_POLICY_READ",
    "POLICIES_EXTERNAL_POLICY_CREATE",
    "POLICIES_EXTERNAL_POLICY_UPDATE",
    "POLICIES_EXTERNAL_POLICY_DELETE",
    "LOG_LOG_READ",
    "LOG_SYSTEM_READ"
  ],
  "permissionsGroup": [
    {
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "roleId": "69a814bfca21314a0a25040f",
      "roleName": "Default policy user",
      "owner": null
    }
  ],
  "location": "local"
}

Registers and fully onboards a new user account.

post

Creates a user account, Hedera account, DID, and cryptographic keys on behalf of the user. If hederaAccountId / hederaAccountKey are omitted the platform generates them.

Body

application/json

usernamestringRequiredExample: NewStandardRegistry

passwordstringRequiredExample: StrongPassword3#

password_confirmationstringRequiredExample: StrongPassword3#

rolestringRequiredExample: STANDARD_REGISTRY

hederaAccountIdstringOptional

Hedera account ID (e.g. 0.0.12345). Auto-generated from the operator account if omitted.

Example: 0.0.12345

hederaAccountKeystringOptional

Hedera account private key. Required when hederaAccountId is provided; auto-generated if omitted.

parentstringOptional

Standard Registry username or DID. Required for USER role accounts to link them to their registry.

Example: registry_username

useFireblocksSigningbooleanOptional

Use Fireblocks signing instead of local key.

Default: false

Responses

202

Task created — poll for completion.

application/json

500

Internal server error.

application/json

post

/accounts/push/onboard

HTTPcURLJavaScriptPython

POST /api/v1/accounts/push/onboard HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 719

{
  "username": "NewStandardRegistry",
  "password": "StrongPassword3#",
  "password_confirmation": "StrongPassword3#",
  "role": "STANDARD_REGISTRY",
  "hederaAccountId": "0.0.12345",
  "hederaAccountKey": "text",
  "parent": "registry_username",
  "vcDocument": {
    "@context": [
      "text"
    ],
    "id": "text",
    "type": "text"
  },
  "didDocument": {
    "id": "text",
    "@context": [
      "text"
    ],
    "alsoKnownAs": [
      "text"
    ],
    "controller": [
      "text"
    ],
    "verificationMethod": [
      {}
    ],
    "authentication": [
      {}
    ],
    "assertionMethod": [
      {}
    ],
    "keyAgreement": [
      {}
    ],
    "capabilityInvocation": [
      {}
    ],
    "capabilityDelegation": [
      {}
    ],
    "service": [
      {}
    ]
  },
  "didKeys": [
    {
      "id": "text",
      "key": "text"
    }
  ],
  "useFireblocksSigning": false,
  "fireblocksConfig": {
    "fireBlocksVaultId": "",
    "fireBlocksAssetId": "",
    "fireBlocksApiKey": "",
    "fireBlocksPrivateiKey": ""
  }
}

{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Logs user into the system.

post

Body

application/json

usernamestringRequiredExample: StandardRegistry

passwordstringRequiredExample: test

otpstringRequired

Responses

200

Successful operation.

application/json

usernamestringRequiredExample: StandardRegistry

didstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

rolestringRequiredExample: STANDARD_REGISTRY

refreshTokenstringRequiredExample: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwNmY2MzIyLTk2NGYtNGIwMC05ZjgwLTljM2Y1OTdjYTYyYSIsIm5hbWUiOiJTdGFuZGFyZFJlZ2lzdHJ5IiwiZXhwaXJlQXQiOjE4MDQ3MDAzOTczMzgsImlhdCI6MTc3MzE2NDM5N30.ODc0_ktbl5xPRn4Ub1Kuj-xrjlho2_oyohucLdgMUqFGrI2SD_T3A96OaV2cKx7NQwsxc-QFBpBnrGSriJ9qPUcDm9rYmQYSqwpRJT0uSuL7xwu4TiPlVzghCd5xlLTw_uA6uJR7CG7HrDphPQI6zMGSxKXcn2S9xIZ6z5uBuWU

weakPasswordbooleanOptionalExample: false

401

Unauthorized request.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/accounts/login

HTTPcURLJavaScriptPython

POST /api/v1/accounts/login HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "username": "StandardRegistry",
  "password": "test"
}

{
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwNmY2MzIyLTk2NGYtNGIwMC05ZjgwLTljM2Y1OTdjYTYyYSIsIm5hbWUiOiJTdGFuZGFyZFJlZ2lzdHJ5IiwiZXhwaXJlQXQiOjE4MDQ3MDAzOTczMzgsImlhdCI6MTc3MzE2NDM5N30.ODc0_ktbl5xPRn4Ub1Kuj-xrjlho2_oyohucLdgMUqFGrI2SD_T3A96OaV2cKx7NQwsxc-QFBpBnrGSriJ9qPUcDm9rYmQYSqwpRJT0uSuL7xwu4TiPlVzghCd5xlLTw_uA6uJR7CG7HrDphPQI6zMGSxKXcn2S9xIZ6z5uBuWU",
  "role": "STANDARD_REGISTRY",
  "username": "StandardRegistry",
  "weakPassword": false
}

Change user password.

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

usernamestringRequiredExample: StandardRegistry

oldPasswordstringRequiredExample: test

newPasswordstringRequiredExample: AnotherStrongPassword3#

Responses

200

Successful operation.

application/json

usernamestringRequiredExample: StandardRegistry

didstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

rolestringRequiredExample: STANDARD_REGISTRY

refreshTokenstringRequiredExample: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwNmY2MzIyLTk2NGYtNGIwMC05ZjgwLTljM2Y1OTdjYTYyYSIsIm5hbWUiOiJTdGFuZGFyZFJlZ2lzdHJ5IiwiZXhwaXJlQXQiOjE4MDQ3MDAzOTczMzgsImlhdCI6MTc3MzE2NDM5N30.ODc0_ktbl5xPRn4Ub1Kuj-xrjlho2_oyohucLdgMUqFGrI2SD_T3A96OaV2cKx7NQwsxc-QFBpBnrGSriJ9qPUcDm9rYmQYSqwpRJT0uSuL7xwu4TiPlVzghCd5xlLTw_uA6uJR7CG7HrDphPQI6zMGSxKXcn2S9xIZ6z5uBuWU

weakPasswordbooleanOptionalExample: false

401

Unauthorized request.

application/json

403

Forbidden

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post

/accounts/change-password

HTTPcURLJavaScriptPython

POST /api/v1/accounts/change-password HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "username": "StandardRegistry",
  "oldPassword": "test",
  "newPassword": "AnotherStrongPassword3#"
}

{
  "username": "StandardRegistry",
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "role": "STANDARD_REGISTRY",
  "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwNmY2MzIyLTk2NGYtNGIwMC05ZjgwLTljM2Y1OTdjYTYyYSIsIm5hbWUiOiJTdGFuZGFyZFJlZ2lzdHJ5IiwiZXhwaXJlQXQiOjE4MDQ3MDAzOTczMzgsImlhdCI6MTc3MzE2NDM5N30.ODc0_ktbl5xPRn4Ub1Kuj-xrjlho2_oyohucLdgMUqFGrI2SD_T3A96OaV2cKx7NQwsxc-QFBpBnrGSriJ9qPUcDm9rYmQYSqwpRJT0uSuL7xwu4TiPlVzghCd5xlLTw_uA6uJR7CG7HrDphPQI6zMGSxKXcn2S9xIZ6z5uBuWU"
}

Returns access token.

post

Returns access token.

Body

application/json

refreshTokenstringRequired

Refresh token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwNmY2MzIyLTk2NGYtNGIwMC05ZjgwLTljM2Y1OTdjYTYyYSIsIm5hbWUiOiJTdGFuZGFyZFJlZ2lzdHJ5IiwiZXhwaXJlQXQiOjE4MDQ3MDAzOTczMzgsImlhdCI6MTc3MzE2NDM5N30.ODc0_ktbl5xPRn4Ub1Kuj-xrjlho2_oyohucLdgMUqFGrI2SD_T3A96OaV2cKx7NQwsxc-QFBpBnrGSriJ9qPUcDm9rYmQYSqwpRJT0uSuL7xwu4TiPlVzghCd5xlLTw_uA6uJR7CG7HrDphPQI6zMGSxKXcn2S9xIZ6z5uBuWU

Responses

200

Successful operation.

application/json

accessTokenstringRequired

Access token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlN0YW5kYXJkUmVnaXN0cnkiLCJkaWQiOiJkaWQ6aGVkZXJhOnRlc3RuZXQ6Q3Z6cDVrS1ZVdWlwQkNRamNGNTRmQmpkaWN2YUtzQjh6SGVRNlFxMjJVMlpfMC4wLjgxNDUzNDgiLCJyb2xlIjoiU1RBTkRBUkRfUkVHSVNUUlkiLCJleHBpcmVBdCI6MTc3MzgzNzIwNDYzOSwiaWF0IjoxNzczMjM3MjA0fQ.R9F3os4r4BdVpIXO1WhMq9GYp4qiAzBESMqVwM4NacCht4oRyR2X62t2VVckHyb8ElN4Igwy9C7CHdkSL3kpGlRHrN8haDbDfWxtMWw3bpRNUc8Wyvx8p8-N_aSOBZMgoWJQo-K6hB4MgXP2lPT0MQ-JDP01eG8Xn6MtQF4dctA

500

Internal server error.

application/json

post

/accounts/access-token

HTTPcURLJavaScriptPython

POST /api/v1/accounts/access-token HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwNmY2MzIyLTk2NGYtNGIwMC05ZjgwLTljM2Y1OTdjYTYyYSIsIm5hbWUiOiJTdGFuZGFyZFJlZ2lzdHJ5IiwiZXhwaXJlQXQiOjE4MDQ3MDAzOTczMzgsImlhdCI6MTc3MzE2NDM5N30.ODc0_ktbl5xPRn4Ub1Kuj-xrjlho2_oyohucLdgMUqFGrI2SD_T3A96OaV2cKx7NQwsxc-QFBpBnrGSriJ9qPUcDm9rYmQYSqwpRJT0uSuL7xwu4TiPlVzghCd5xlLTw_uA6uJR7CG7HrDphPQI6zMGSxKXcn2S9xIZ6z5uBuWU"
}

{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlN0YW5kYXJkUmVnaXN0cnkiLCJkaWQiOiJkaWQ6aGVkZXJhOnRlc3RuZXQ6Q3Z6cDVrS1ZVdWlwQkNRamNGNTRmQmpkaWN2YUtzQjh6SGVRNlFxMjJVMlpfMC4wLjgxNDUzNDgiLCJyb2xlIjoiU1RBTkRBUkRfUkVHSVNUUlkiLCJleHBpcmVBdCI6MTc3MzgzNzIwNDYzOSwiaWF0IjoxNzczMjM3MjA0fQ.R9F3os4r4BdVpIXO1WhMq9GYp4qiAzBESMqVwM4NacCht4oRyR2X62t2VVckHyb8ElN4Igwy9C7CHdkSL3kpGlRHrN8haDbDfWxtMWw3bpRNUc8Wyvx8p8-N_aSOBZMgoWJQo-K6hB4MgXP2lPT0MQ-JDP01eG8Xn6MtQF4dctA"
}

Returns a list of users, excluding Standard Registry.

get

Returns all users except those with role Standard Registry. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

usernamestringRequiredExample: Installer

parentstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

didstringOptionalExample: did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/accounts

HTTPcURLJavaScriptPython

GET /api/v1/accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "username": "Installer",
    "parent": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599"
  },
  {
    "username": "Installer2"
  }
]

Returns all Standard Registries.

get

Returns all Standard Registries.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

usernamestringRequiredExample: StandardRegistry

didstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/accounts/standard-registries

HTTPcURLJavaScriptPython

GET /api/v1/accounts/standard-registries HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "username": "StandardRegistry",
    "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599"
  },
  {
    "username": "Verra"
  }
]

Returns all Standard Registries aggregated with polices and vcDocuments.

get

Returns all Standard Registries aggregated with polices and vcDocuments

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

didstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

usernamestringRequiredExample: StandardRegistry

hederaAccountIdstringRequiredExample: 0.0.6046379

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/accounts/standard-registries/aggregated

HTTPcURLJavaScriptPython

GET /api/v1/accounts/standard-registries/aggregated HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "vcDocument": {
      "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"
    },
    "policies": [
      {
        "createDate": "2026-03-13T13:32:08.119Z",
        "uuid": "595d65e6-1fc6-42ec-a72d-a12fb2313218",
        "name": "VM0044_1741272604219",
        "version": "1",
        "description": "VM0044",
        "status": "PUBLISH",
        "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "policyRoles": [
          "Project_Proponent",
          "VVB"
        ],
        "policyGroups": [],
        "topicId": "0.0.8204101",
        "instanceTopicId": "0.0.8204176",
        "policyTag": "Tag_1773408686116",
        "messageId": "1773409092.761373000",
        "codeVersion": "1.5.1",
        "tools": [
          {
            "name": "Tool 05",
            "version": null,
            "topicId": "0.0.3418637",
            "messageId": "1707833182.503204122"
          },
          {
            "name": "Tool 07",
            "version": null,
            "topicId": "0.0.2175383",
            "messageId": "1706867530.884259218"
          },
          {
            "name": "Tool 12",
            "version": null,
            "topicId": "0.0.3625013",
            "messageId": "1709106946.913157840"
          },
          {
            "name": "Tool 03",
            "version": null,
            "topicId": "0.0.2182119",
            "messageId": "1706867833.676387003"
          }
        ],
        "userRoles": [
          "Administrator"
        ],
        "userGroups": [],
        "userRole": "Administrator",
        "userGroup": null,
        "tests": [],
        "id": "69b411d8b23f3b6a77d12742"
      },
      {
        "createDate": "2026-03-13T13:24:21.116Z",
        "uuid": "ef137508-3e02-4ee3-92fa-8847ca1687cf",
        "name": "CDM AMS-III.AR Policy",
        "version": "1",
        "description": "Substituting fossil fuel-based lighting with LED/CFL lighting systems",
        "status": "PUBLISH",
        "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "policyRoles": [
          "Project Participant",
          "VVB"
        ],
        "policyGroups": [],
        "topicId": "0.0.8204020",
        "instanceTopicId": "0.0.8204046",
        "policyTag": "Tag_1773408218292",
        "messageId": "1773408455.836215124",
        "codeVersion": "1.5.1",
        "tools": [
          {
            "name": "Tool 33",
            "version": null,
            "topicId": "0.0.4865949",
            "messageId": "1726593517.484578000"
          },
          {
            "name": "Tool 19",
            "version": null,
            "topicId": "0.0.2196124",
            "messageId": "1706869798.177938003"
          },
          {
            "name": "Tool 21",
            "version": null,
            "topicId": "0.0.2203279",
            "messageId": "1706873385.455822873"
          },
          {
            "name": "Tool 07",
            "version": null,
            "topicId": "0.0.2175383",
            "messageId": "1706867530.884259218"
          }
        ],
        "userRoles": [
          "Administrator"
        ],
        "userGroups": [],
        "userRole": "Administrator",
        "userGroup": null,
        "tests": [],
        "id": "69b41005b23f3b6a77d125ed"
      }
    ],
    "username": "StandardRegistry",
    "hederaAccountId": "0.0.6046379"
  },
  {
    "did": "did:hedera:testnet:AacaQZTo8bEEecUXTZMar5BvZjAkvsEAFcD6NmzgXt5K_0.0.8148963",
    "vcDocument": {
      "createDate": "2026-03-13T13:34:33.856Z",
      "updateDate": "2026-03-13T13:34:47.849Z",
      "hash": "2L9fzuBnQpQnnZeSXXQi3NTuXDsJG5YjeeDRj4wWomhi",
      "hederaStatus": "ISSUE",
      "signature": 0,
      "type": "STANDARD_REGISTRY",
      "option": {
        "status": "NEW"
      },
      "owner": "did:hedera:testnet:DtFfFAkJo9QLV8dqsMfWF2BEC5VFkVn4BzGqaAjkjpic_0.0.8204128",
      "topicId": "0.0.8204128",
      "messageId": "1773408887.187315595",
      "document": {
        "id": "urn:uuid:af79517f-940f-4e7a-b895-2f2f1682b493",
        "type": [
          "VerifiableCredential"
        ],
        "issuer": "did:hedera:testnet:DtFfFAkJo9QLV8dqsMfWF2BEC5VFkVn4BzGqaAjkjpic_0.0.8204128",
        "issuanceDate": "2026-03-13T13:34:33.794Z",
        "@context": [
          "https://www.w3.org/2018/credentials/v1",
          "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
        ],
        "credentialSubject": [
          {
            "OrganizationName": "Some orgname",
            "Website": "https://test.test",
            "Tags": "test",
            "@context": [
              "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
            ],
            "id": "did:hedera:testnet:DtFfFAkJo9QLV8dqsMfWF2BEC5VFkVn4BzGqaAjkjpic_0.0.8204128",
            "type": "StandardRegistry"
          }
        ],
        "proof": {
          "type": "Ed25519Signature2018",
          "created": "2026-03-13T13:34:33Z",
          "verificationMethod": "did:hedera:testnet:DtFfFAkJo9QLV8dqsMfWF2BEC5VFkVn4BzGqaAjkjpic_0.0.8204128#did-root-key",
          "proofPurpose": "assertionMethod",
          "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..9eDfxnIaEfkx17NwOsVJK6JrWu4zXgz1tYPhE5g-O1zlFaWO3a6KLv0UtrgHcob-yDFx4k9avcJJmFN3aowSCg"
        }
      },
      "documentFileId": "69b41277b23f3b6a77d127a5",
      "tableFileIds": [],
      "id": "69b41269b23f3b6a77d1279e"
    },
    "policies": [],
    "username": "Verra",
    "hederaAccountId": "0.0.8148961"
  }
]

Returns user's Hedera account balance.

get

Requests current Hedera account balance.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

balancestringRequiredExample: 833.88244301 ℏ

unitstringRequiredExample: HBar

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/accounts/balance

HTTPcURLJavaScriptPython

GET /api/v1/accounts/balance HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "balance": "833.88244301 ℏ",
  "unit": "Hbar",
  "user": {
    "username": "StandardRegistry",
    "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599"
  }
}

Generate an OTP secret for 2FA setup.

post

Generate an OTP secret for 2FA setup.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

issuerstringRequiredExample: OS Guardian

userstringRequiredExample: StandardRegistry

secretstringRequiredExample: AAA0AA0A0A00A000

urlstringRequiredExample: otpauth://totp/OS%20Guardian:StandardRegistry?issuer=OS+Guardian&period=30&secret=XXX0XX0X0X00X000

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/accounts/otp/generate

HTTPcURLJavaScriptPython

POST /api/v1/accounts/otp/generate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "issuer": "OS Guardian",
  "user": "StandardRegistry",
  "secret": "AAA0AA0A0A00A000",
  "url": "otpauth://totp/OS%20Guardian:StandardRegistry?issuer=OS+Guardian&period=30&secret=XXX0XX0X0X00X000",
  "config": {
    "algo": "sha1",
    "digits": 111,
    "period": 111,
    "secretSize": 111
  }
}

Confirm OTP setup.

post

Confirm OTP setup by OTP token.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

tokenstringRequiredExample: 111111

Responses

200

Successful operation.

application/json

successbooleanRequiredExample: true

backupCodesstring[]RequiredExample: ["000000","111111","222222","333333","444444","555555","666666","777777","888888","999999"]

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/accounts/otp/confirm

HTTPcURLJavaScriptPython

POST /api/v1/accounts/otp/confirm HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "token": "111111"
}

{
  "success": true,
  "backupCodes": [
    "000000",
    "111111",
    "222222",
    "333333",
    "444444",
    "555555",
    "666666",
    "777777",
    "888888",
    "999999"
  ]
}

Get OTP status.

get

Get OTP status for the current user.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

enabledbooleanRequiredExample: true

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/accounts/otp/status

HTTPcURLJavaScriptPython

GET /api/v1/accounts/otp/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true
}

Deactivate 2FA.

post

Deactivate 2FA.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

object · EmptyResponseDTOOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/accounts/otp/deactivate

HTTPcURLJavaScriptPython

POST /api/v1/accounts/otp/deactivate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}