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

Entities

Get file

get

Returns file

Path parameters
cidstringRequired

CID

Example: bafybe...3w5sk3m
Responses
200

File

application/json
stringOptional
get
/entities/ipfs/{cid}

Get standard registries

get

Returns standard registries

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search registries, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Global topic identifier

Example: 0.0.1960
options.didstringOptional

Registry did

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
options.registrantTopicIdstringOptional

Registry user topic identifier

Example: 0.0.4481265
options.attributes.OrganizationNamestringOptional

Registry organization name

Example: Example
Responses
200

Registries

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/registries

Get registry

get

Returns registry

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Registry details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/registries/{messageId}

Get registry relationships

get

Returns registry relationships

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Registry relationships

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/registries/{messageId}/relationships

Get registry users

get

Returns registry users

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search registry users, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

User topic identifier

Example: 0.0.1960
Responses
200

Registry users

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/registry-users

Get registry user

get

Returns registry user

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Registry user details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/registry-users/{messageId}

Get policies

get

Returns policies

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search policies, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Policy topic identifier

Example: 0.0.1960
options.ownerstringOptional

Policy owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
analytics.toolsstringOptional

Tool

Example: 1706823227.586179534
Responses
200

Policies

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/policies

Get policy

get

Returns policy

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Policy details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/policies/{messageId}

Get policy relationships

get

Returns policy relationships

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Policy relationships

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/policies/{messageId}/relationships

Get tools

get

Returns tools

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search tools, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
options.ownerstringOptional

Tool owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
topicIdstringOptional

Topic identifier

Example: 0.0.1960
Responses
200

Tools

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/tools

Get tool

get

Returns tool

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Tool details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/tools/{messageId}

Get modules

get

Returns modules

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search modules, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
options.ownerstringOptional

Module owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
topicIdstringOptional

Topic identifier

Example: 0.0.1960
Responses
200

Modules

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/modules

Get module

get

Returns module

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Module details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/modules/{messageId}

Get schemas

get

Returns schemas

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search schemas, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Policy topic identifier

Example: 0.0.1960
options.ownerstringOptional

Schema owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
Responses
200

Schemas

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/schemas

Get schema

get

Returns schema

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Schema details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/schemas/{messageId}

Get schema tree

get

Returns schema tree

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Schema tree

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
get
/entities/schemas/{messageId}/tree

Get schemas packages

get

Returns schemas packages

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search schemas packages, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Policy topic identifier

Example: 0.0.1960
options.ownerstringOptional

Schema owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
Responses
200

Schemas

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/schemas-packages

Get schemas package

get

Returns schemas package

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Schemas package details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/schemas-packages/{messageId}

Get tokens

get

Returns tokens

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
tokenIdstringOptional

Token identifier

Example: 0.0.1960
treasurystringOptional

Treasury

Example: 0.0.1960
topicIdstringOptional

Topic identifier

Example: 0.0.1960
Responses
200

Tokens

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/tokens

Get token

get

Returns token

Path parameters
tokenIdstringRequired

Token identifier

Example: 0.0.1960
Responses
200

Token details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
get
/entities/tokens/{tokenId}

Get roles

get

Returns roles

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search roles, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
options.rolestringRequired
analytics.srstringRequired
topicIdstringOptional

Topic identifier

Example: 0.0.1960
analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534
Responses
200

Roles

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/roles

Get role

get

Returns role

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Role details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/roles/{messageId}

Get statistics

get

Returns statistics

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search statistics, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Statistic topic identifier

Example: 0.0.1960
options.ownerstringOptional

Statistic owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
options.policystringOptional

Policy

Example: 1706823227.586179534
Responses
200

Statistics

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/statistics

Get statistic

get

Returns statistic

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Statistic details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/statistics/{messageId}

Get VCs

get

Returns VCs

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search VCs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Topic identifier

Example: 0.0.1960
options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534
analytics.schemaIdstringOptional

Schema identifier

Example: 1706823227.586179534
options.relationshipsstringOptional

Relationships

Example: 1706823227.586179534
Responses
200

VCs

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/statistic-documents

Get labels

get

Returns labels

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search labels, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Label topic identifier

Example: 0.0.1960
options.ownerstringOptional

Label owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
options.policystringOptional

Policy

Example: 1706823227.586179534
Responses
200

Labels

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/labels

Get label

get

Returns label

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Label details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/labels/{messageId}

Get label document

get

Returns label document

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Label document details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/label-documents/{messageId}

Get Label Documents

get

Returns Label Documents

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search VPs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Topic identifier

Example: 0.0.1960
options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534
analytics.schemaIdsstringOptional

Schema identifier

Example: 1706823227.586179534
Responses
200

Label Documents

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/label-documents

Get formulas

get

Returns formulas

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search formulas, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Policy topic identifier

Example: 0.0.1960
options.ownerstringOptional

formula owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
Responses
200

formulas

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/formulas

Get formula

get

Returns formula

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Formula details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/formulas/{messageId}

Get formula relationships

get

Returns formula relationships

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Formula relationships

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
get
/entities/formulas/{messageId}/relationships

Get DIDs

get

Returns DIDs

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search DIDs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Topic identifier

Example: 0.0.1960
options.didstringOptional

DID

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
Responses
200

DIDs

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/did-documents

Get DID

get

Returns DID

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

DID details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/did-documents/{messageId}

Get DID relationships

get

Returns DID relationships

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

DID relationships

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/did-documents/{messageId}/relationships

Get VPs

get

Returns VPs

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search VPs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Topic identifier

Example: 0.0.1960
options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534
analytics.schemaIdsstringOptional

Schema identifier

Example: 1706823227.586179534
Responses
200

VPs

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/vp-documents

Get VP

get

Returns VP

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

VP details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/vp-documents/{messageId}

Get VP relationships

get

Returns VP relationships

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

VP relationships

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/vp-documents/{messageId}/relationships

Get VCs

get

Returns VCs

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search VCs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Topic identifier

Example: 0.0.1960
options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265
analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534
analytics.schemaIdstringOptional

Schema identifier

Example: 1706823227.586179534
options.relationshipsstringOptional

Relationships

Example: 1706823227.586179534
Responses
200

VCs

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/vc-documents

Get VC

get

Returns VC

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

VC details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
formulasDataobjectRequired

Formulas data

get
/entities/vc-documents/{messageId}

Get VC relationships

get

Returns VC relationships

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

VC relationships

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/vc-documents/{messageId}/relationships

Get VC comments

get

Returns VC comments

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

VC comments

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/vc-documents/{messageId}/discussions

Get VC comments

get

Returns VC comments

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
discussionIdstringRequired

Message identifier

Example: 1706823227.586179534
Query parameters
pageIndexnumberRequired
pageSizenumberRequired
Responses
200

VC comments

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]
get
/entities/vc-documents/{messageId}/discussions/{discussionId}/comments

Get NFTs

get

Returns NFTs

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
tokenIdstringOptional

Token identifier

Example: 0.0.1960
Responses
200

NFTs

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/nfts

Get NFT

get

Returns NFT

Path parameters
tokenIdstringRequired

Token identifier

Example: 0.0.1960
serialNumberstringRequired

Serial number

Example: 1
Responses
200

NFT details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
historyobject[]Required

NFT transaction history

Example: [{"consensus_timestamp":"1707292471.903596642","nonce":0,"transaction_id":"0.0.1533323-1707292459-175375906","type":"CRYPTOTRANSFER","is_approval":false,"receiver_account_id":"0.0.1842221","sender_account_id":"0.0.1533323"},{"consensus_timestamp":"1707292470.199625477","nonce":0,"transaction_id":"0.0.1533323-1707292458-093221893","type":"TOKENMINT","is_approval":false,"receiver_account_id":"0.0.1533323","sender_account_id":null}]
get
/entities/nfts/{tokenId}/{serialNumber}

Get topics

get

Returns topics

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search topics, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
options.parentIdstringOptional

Parent topic identifier

Example: 0.0.1960
Responses
200

Topics

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/topics

Get topic

get

Returns topic

Path parameters
topicIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Topic details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/topics/{topicId}

Get contracts

get

Returns contracts

Query parameters
pageIndexnumberOptional

Page index

Example: 0
pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp
orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}
keywordsstringOptional

Keywords to search

Example: {"description":"Search contracts, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}
topicIdstringOptional

Topic identifier

Example: 0.0.1960
ownerstringOptional

Owner

Example: 0.0.2160
Responses
200

Contracts

application/json
pageIndexnumberRequired

Page index

Example: 0
pageSizenumberRequired

Page size

Example: 10
totalnumberRequired

Total size

Example: 100
orderobjectRequired

Order

get
/entities/contracts

Get contract

get

Returns contract

Path parameters
messageIdstringRequired

Message identifier

Example: 1706823227.586179534
Responses
200

Contract details

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7
get
/entities/contracts/{messageId}

Try to load ipfs files

post

Returns ipfs files

Body
messageIdstringRequired

Entity Timestamp

Example: 1706823227.586179534
Responses
200

ipfs files

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
post
/entities/update-files

Try to unpack schemas

post

Returns schemas

Body
messageIdstringRequired

Entity Timestamp

Example: 1706823227.586179534
Responses
200

Try to unpack schemas

application/json
idstringRequired

Message identifier

Example: 1706823227.586179534
post
/entities/unpack-schemas

Last updated