Returns VC Documents

Get VCs

get

Returns VCs

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

Example: 10

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

Responseall of

and

500

Internal server error

application/json

get

/entities/vc-documents

HTTPcURLJavaScriptPython

GET /api/v1/entities/vc-documents HTTP/1.1
Host: 
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "type": "VC-Document",
      "action": "create-vc-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ],
        "documentStatus": "Approved",
        "encodedData": true
      },
      "analytics": {
        "policyId": "1706823227.586179534",
        "schemaId": "1706823227.586179534",
        "schemaName": "Monitoring Report",
        "textSearch": "text"
      }
    }
  ]
}