Latest

This moving API is selected by omitting the api-version query parameter or by passing api-version=latest to endpoints under the /gov prefix. latest does not pin a compatibility contract: it always selects the API implemented by the running CCF build.

GET /gov/api

OpenAPI schema

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/commit

Current commit level

Latest transaction ID that has been committed on the service

Query Parameters:

  • view_history (boolean)

  • view_history_since (integer)

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/members/proposals

List governance proposals

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/members/proposals/{proposalId}

Get a governance proposal

Parameters:

  • proposalId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/members/proposals/{proposalId}/actions

Get a proposal’s actions

Parameters:

  • proposalId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/members/proposals/{proposalId}/ballots/{memberId}

Get a member’s ballot

Parameters:

  • proposalId (string)

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

POST /gov/members/proposals/{proposalId}/ballots/{memberId}:submit

Submit a ballot

Parameters:

  • proposalId (string)

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

POST /gov/members/proposals/{proposalId}:withdraw

Withdraw a governance proposal

Parameters:

  • proposalId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • 204 No Content – The proposal no longer exists.

  • default – An error occurred

POST /gov/members/proposals:create

Create a governance proposal

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/members/state-digests/{memberId}

Get a member’s state digest

Parameters:

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

POST /gov/members/state-digests/{memberId}:ack

Acknowledge a member’s state digest

Parameters:

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 204 No Content – Default response description

  • default – An error occurred

POST /gov/members/state-digests/{memberId}:update

Update a member’s state digest

Parameters:

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/receipt

Receipt for a transaction

A signed statement from the service over a transaction entry in the ledger

Query Parameters:

  • transaction_id (string) – (Required)

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • 202 Accepted – The transaction is not yet available. The response describes why and the Retry-After header indicates when to retry.

  • default – An error occurred

GET /gov/receipt/cose

COSE receipt for a transaction

A COSE Sign1 envelope containing a signed statement from the service over a transaction entry in the ledger, with a Merkle proof in the unprotected header. See https://datatracker.ietf.org/doc/draft-ietf-scitt-receipts-ccf-profile/ for a complete description.

Query Parameters:

  • transaction_id (string) – (Required)

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • 202 Accepted – The transaction is not yet available. The response describes why and the Retry-After header indicates when to retry.

  • default – An error occurred

GET /gov/recovery/encrypted-shares/{memberId}

Get an encrypted recovery share

Parameters:

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

POST /gov/recovery/members/{memberId}:recover

Submit a recovery share

Parameters:

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/constitution

Get the service constitution

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/info

Get service information

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/javascript-app

Get the installed JavaScript application

Query Parameters:

  • case (string)

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/javascript-modules

List JavaScript modules

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/javascript-modules/{moduleName}

Get a JavaScript module

Parameters:

  • moduleName (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/join-policy

Get the service join policy

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/jwk

Get accepted JWT issuers and keys

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/members

List consortium members

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/members/{memberId}

Get a consortium member

Parameters:

  • memberId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/nodes

List service nodes

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/nodes/{nodeId}

Get a service node

Parameters:

  • nodeId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/transactions/commit

Get the latest committed transaction

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/transactions/{transactionId}

Get transaction status

Parameters:

  • transactionId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/users

List application users

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/service/users/{userId}

Get an application user

Parameters:

  • userId (string)

Query Parameters:

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred

GET /gov/tx

Current status of a transaction

Possible statuses returned are Unknown, Pending, Committed or Invalid.

Query Parameters:

  • transaction_id (string) – (Required)

  • api-version (string) – Optional API selector. ‘latest’ selects the API implemented by this CCF build and does not identify a frozen contract. Dated versions select frozen compatibility contracts while they remain supported.

Status Codes:

  • 200 OK – Default response description

  • default – An error occurred