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

Modules

Return a list of all modules.

get

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

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
Responses
200

Successful operation.

application/json
get
/modules

Creates a new module.

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
post
/modules

Return a list of all module schemas.

get

Returns all module schemas. Only users with the Standard Registry role are allowed to make the request.

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
topicIdstringOptional

Filter module schemas by topic id.

Example: 0.0.6046379
Responses
200

Successful operation.

application/json
get
/modules/schemas

Creates a new module schema.

post

Creates a new module schema. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
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:
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
topicCountnumber · nullableOptionalExample: 1
Responses
post
/modules/schemas

Retrieves module configuration.

get

Retrieves module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request.

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

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Successful operation.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
get
/modules/{uuid}

Updates module configuration.

put

Updates module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request.

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

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
put
/modules/{uuid}

Deletes the module.

delete

Deletes the module with the provided module ID. Only users with the Standard Registry role are allowed to make the request.

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

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Successful operation.

application/json
booleanOptional
delete
/modules/{uuid}

Return a list of modules.

get

Returns modules menu. Only users with the Standard Registry role are allowed to make the request.

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

Modules.

application/json
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
get
/modules/menu

Return module and its artifacts in a zip file format for the specified module.

get

Returns a zip file containing the published module and all associated artifacts, i.e. schemas and VCs. Only users with the Standard Registry role are allowed to make the request.

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

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Binary ZIP archive (Content-Type: application/zip, Content-Disposition: attachment). Not JSON.

application/zip
string · binaryOptional
get
/modules/{uuid}/export/file

Return Heder message ID for the specified published module.

get

Returns the Hedera message ID for the specified module published onto IPFS. Only users with the Standard Registry role are allowed to make the request.

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

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Message.

application/json
uuidstringRequired
namestringRequired
descriptionstringRequired
messageIdstringRequired
ownerstringRequired
get
/modules/{uuid}/export/message

Imports new module from IPFS.

post

Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequired

Hedera topic message id

Responses
post
/modules/import/message

Imports new module from a zip file.

post

Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
string · binaryOptional
Responses
post
/modules/import/file

Imports new module from IPFS.

post

Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequired

Hedera topic message id

Responses
200

Module preview.

application/json
messageIdstringRequired
schemasobject[] · nullableRequired
tagsobject[] · nullableRequired
moduleTopicIdstring · nullableRequired
post
/modules/import/message/preview

Imports new module from a zip file.

post

Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
string · binaryOptional
Responses
200

Module preview.

application/json
schemasobject[] · nullableRequired
tagsobject[] · nullableRequired
post
/modules/import/file/preview

Publishes the module onto IPFS.

put

Publishes the module with the specified (internal) module ID onto IPFS, sends a message featuring its IPFS CID into the corresponding Hedera topic. Only users with the Standard Registry role are allowed to make the request.

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

Module Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
200

Successful operation.

application/json
isValidbooleanRequired

Whether validation passed and the module was published

put
/modules/{uuid}/publish

Validates selected module.

post

Validates selected module. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRequired
uuidstringRequired
typestring · nullableOptional
namestringRequired
descriptionstringRequired
statusstringRequired
creatorstringRequired
ownerstringRequired
topicIdstring · nullableOptional
messageIdstring · nullableOptional
codeVersionstringRequired
createDatestringRequired
updateDatestring · nullableOptional
configFileIdstring · nullableOptional
contentFileIdstring · nullableOptional
menustring · nullableOptional
Responses
200

Validation result.

application/json
post
/modules/validate

Last updated