Contract-Agreements

This section provides an overview of all available APIs that adhere to the OpenAPI specification. All APIs are loaded from the OpenAPI specification file: Link. Please note that the API base-paths may differ depending on the connector, the specific API base-path can be seen in the UI dashboard.

---

---

---

post

Initiate a Transfer Process via a custom Transfer Process JSON-LD. Fields such as connectorId, assetId, providerConnectorId, providerConnectorAddress will be set automatically.

Body

application/json

Required data for starting a Contract Agreement's Transfer Process

contractAgreementIdstringRequired

Contract Agreement ID

transferProcessRequestJsonLdstringRequired

Partial TransferProcessRequestJsonLd JSON-LD. Fields participantId, connectorEndpoint, assetId and contractId can be omitted, they will be overridden with information from the contract.

Responses

default

default response

application/json

post

/wrapper/ui/pages/contract-agreement-page/transfers/custom

HTTPcURLJavaScriptPython

POST /api/management/wrapper/ui/pages/contract-agreement-page/transfers/custom HTTP/1.1
Host: my-connector
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "contractAgreementId": "text",
  "transferProcessRequestJsonLd": "text"
}

default

default response

{
  "id": "text",
  "lastUpdatedDate": "2025-12-19T13:50:19.757Z"
}

---

---

post

Terminates a contract agreement designated by its contract agreement id.

Path parameters

contractAgreementIdstringRequired

Body

application/json

Data for terminating a Contract Agreement

detailstring · max: 1000Required

A user explanation to detail why the contract was terminated.

reasonstring · max: 100Required

A short reason why this contract was terminated

Responses

default

default response

application/json

post

/wrapper/ui/pages/content-agreement-page/{contractAgreementId}/terminate

HTTPcURLJavaScriptPython

POST /api/management/wrapper/ui/pages/content-agreement-page/{contractAgreementId}/terminate HTTP/1.1
Host: my-connector
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "detail": "text",
  "reason": "text"
}

default

default response

{
  "id": "text",
  "lastUpdatedDate": "2025-12-19T13:50:19.757Z"
}