External

Integration with external data sources and third-party systems.

Sends data from an external source.

post

Sends data from an external source.

Path parameters

policyIdstringRequired

Target policy identifier

Example: 69aeb71ef8c5b278e3bab4e5

blockTagstringRequired

Target block tag in policy

Example: external_data_block

Body

application/json

ownerstringRequired

policyTagstringRequired

Responses

200

Successful operation.

application/json

booleanOptional

500

Internal server error.

application/json

post/external/{policyId}/{blockTag}

HTTPcURLJavaScriptPython

POST /api/v1/external/{policyId}/{blockTag} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 843

{
  "owner": "string",
  "policyTag": "string",
  "document": {
    "id": "8f457a5a-c02b-4a18-a7d3-20e4def1bf7f",
    "@context": [
      "https://www.w3.org/2018/credentials/v1"
    ],
    "type": [
      "VerifiableCredential",
      "a2274869-4a41-4446-8efd-dacde5a81221"
    ],
    "credentialSubject": [
      {
        "id": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
        "field0": "value0",
        "field1": "value1",
        "policyId": "69c42569ae73da728c8d9027",
        "accountId": "0.0.1774462367074"
      }
    ],
    "issuer": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
    "issuanceDate": "2026-03-25T17:12:17.150Z",
    "proof": {
      "type": "Ed25519Signature2018",
      "created": "2026-03-25T17:12:17.150Z",
      "verificationMethod": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919#did-root-key",
      "proofPurpose": "assertionMethod",
      "jws": "eyJhbGciOiJFZERTQSJ9..signature"
    }
  }
}

true

Sends data from an external source.

post

Sends data from an external source.

Body

application/json

ownerstringRequired

policyTagstringRequired

Responses

200

Successful operation.

application/json

booleanOptional

500

Internal server error.

application/json

post/external

HTTPcURLJavaScriptPython

POST /api/v1/external HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 843

{
  "owner": "string",
  "policyTag": "string",
  "document": {
    "id": "8f457a5a-c02b-4a18-a7d3-20e4def1bf7f",
    "@context": [
      "https://www.w3.org/2018/credentials/v1"
    ],
    "type": [
      "VerifiableCredential",
      "a2274869-4a41-4446-8efd-dacde5a81221"
    ],
    "credentialSubject": [
      {
        "id": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
        "field0": "value0",
        "field1": "value1",
        "policyId": "69c42569ae73da728c8d9027",
        "accountId": "0.0.1774462367074"
      }
    ],
    "issuer": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
    "issuanceDate": "2026-03-25T17:12:17.150Z",
    "proof": {
      "type": "Ed25519Signature2018",
      "created": "2026-03-25T17:12:17.150Z",
      "verificationMethod": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919#did-root-key",
      "proofPurpose": "assertionMethod",
      "jws": "eyJhbGciOiJFZERTQSJ9..signature"
    }
  }
}

true

Sends data from an external source.

post

Sends data from an external source.

Path parameters

policyIdstringRequired

Target policy identifier

Example: 69aeb71ef8c5b278e3bab4e5

blockTagstringRequired

Target block tag in policy

Example: external_data_block

Query parameters

historybooleanOptional

Include execution history in sync events response

Example: true

Body

application/json

ownerstringRequired

policyTagstringRequired

Responses

200

Successful operation.

application/json

stepsobject[]Required

500

Internal server error.

application/json

post/external/{policyId}/{blockTag}/sync-events

HTTPcURLJavaScriptPython

POST /api/v1/external/{policyId}/{blockTag}/sync-events HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 843

{
  "owner": "string",
  "policyTag": "string",
  "document": {
    "id": "8f457a5a-c02b-4a18-a7d3-20e4def1bf7f",
    "@context": [
      "https://www.w3.org/2018/credentials/v1"
    ],
    "type": [
      "VerifiableCredential",
      "a2274869-4a41-4446-8efd-dacde5a81221"
    ],
    "credentialSubject": [
      {
        "id": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
        "field0": "value0",
        "field1": "value1",
        "policyId": "69c42569ae73da728c8d9027",
        "accountId": "0.0.1774462367074"
      }
    ],
    "issuer": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
    "issuanceDate": "2026-03-25T17:12:17.150Z",
    "proof": {
      "type": "Ed25519Signature2018",
      "created": "2026-03-25T17:12:17.150Z",
      "verificationMethod": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919#did-root-key",
      "proofPurpose": "assertionMethod",
      "jws": "eyJhbGciOiJFZERTQSJ9..signature"
    }
  }
}

{
  "response": {},
  "result": null,
  "steps": []
}

Sends data from an external source.

post

Sends data from an external source.

Query parameters

historybooleanOptional

History

Example: true

Body

application/json

ownerstringRequired

policyTagstringRequired

Responses

200

Successful operation.

application/json

stepsobject[]Required

500

Internal server error.

application/json

post/external/sync-events

HTTPcURLJavaScriptPython

POST /api/v1/external/sync-events HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 843

{
  "owner": "string",
  "policyTag": "string",
  "document": {
    "id": "8f457a5a-c02b-4a18-a7d3-20e4def1bf7f",
    "@context": [
      "https://www.w3.org/2018/credentials/v1"
    ],
    "type": [
      "VerifiableCredential",
      "a2274869-4a41-4446-8efd-dacde5a81221"
    ],
    "credentialSubject": [
      {
        "id": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
        "field0": "value0",
        "field1": "value1",
        "policyId": "69c42569ae73da728c8d9027",
        "accountId": "0.0.1774462367074"
      }
    ],
    "issuer": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919",
    "issuanceDate": "2026-03-25T17:12:17.150Z",
    "proof": {
      "type": "Ed25519Signature2018",
      "created": "2026-03-25T17:12:17.150Z",
      "verificationMethod": "did:hedera:testnet:4YZuEXk95TMt2WfuAB5UYJMQSgSfUgBNutnZioUVAxkR_0.0.1774462341919#did-root-key",
      "proofPurpose": "assertionMethod",
      "jws": "eyJhbGciOiJFZERTQSJ9..signature"
    }
  }
}

{
  "response": {},
  "result": null,
  "steps": []
}