Make a Canton call

Submits one Canton call. `type` names the call and selects the shape of `payload`; `vaultAccountId` and `blockchainId` name the wallet that makes it, and are the same for every `type`. {"type":"DTCC_END_INVESTOR_INVITE","vaultAccountId":"12","blockchainId":"CANTON", "payload":{"endInvestor":"investor-party::1220abc…"}} `payload` is optional on `DTCC_PARTICIPANT_ONBOARDING`, where every field it holds is. An unknown or missing `type`, or a `payload` missing a required field, is a `400`. A field that does not belong to the selected `type` is ignored rather than rejected. A `501` has two different causes, and the distinction is permanent rather than a build-order detail, so it belongs in the published spec: NO CANTON CAPABILITY — specified so the contract is complete, but not available in v1: `DTCC_END_INVESTOR_INVITE_CANCEL`, `DTCC_ALLOW_LIST_ADD`, `DTCC_ALLOW_LIST_REMOVE`. NO HANDLER YET — the capability exists and the type is being wired one slice at a time. To withdraw an allocation, answer the allocation offer with `ALLOCATION_WITHDRAW` on `/offers/{offerId}/responses` — it is not a call.

POST

operations

canton

calls

Make a Canton call

curl --request POST \
  --url https://api.fireblocks.io/v1/operations/canton/calls \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "DTCC_PARTICIPANT_ONBOARDING",
  "vaultAccountId": "12",
  "blockchainId": "CANTON",
  "payload": {
    "expiresAt": "2026-12-31T23:59:59Z",
    "operator": "dtcc-operator::1220abc…",
    "compliance": "dtcc-compliance::1220abc…",
    "registrar": "dtcc-registrar::1220abc…",
    "clientOnboarder": "dtcc-onboarder::1220abc…",
    "upgrader": "dtcc-upgrader::1220abc…"
  }
}
'

import requests

url = "https://api.fireblocks.io/v1/operations/canton/calls"

payload = {
    "type": "DTCC_PARTICIPANT_ONBOARDING",
    "vaultAccountId": "12",
    "blockchainId": "CANTON",
    "payload": {
        "expiresAt": "2026-12-31T23:59:59Z",
        "operator": "dtcc-operator::1220abc…",
        "compliance": "dtcc-compliance::1220abc…",
        "registrar": "dtcc-registrar::1220abc…",
        "clientOnboarder": "dtcc-onboarder::1220abc…",
        "upgrader": "dtcc-upgrader::1220abc…"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'DTCC_PARTICIPANT_ONBOARDING',
    vaultAccountId: '12',
    blockchainId: 'CANTON',
    payload: {
      expiresAt: '2026-12-31T23:59:59Z',
      operator: 'dtcc-operator::1220abc…',
      compliance: 'dtcc-compliance::1220abc…',
      registrar: 'dtcc-registrar::1220abc…',
      clientOnboarder: 'dtcc-onboarder::1220abc…',
      upgrader: 'dtcc-upgrader::1220abc…'
    }
  })
};

fetch('https://api.fireblocks.io/v1/operations/canton/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/operations/canton/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'DTCC_PARTICIPANT_ONBOARDING',
    'vaultAccountId' => '12',
    'blockchainId' => 'CANTON',
    'payload' => [
        'expiresAt' => '2026-12-31T23:59:59Z',
        'operator' => 'dtcc-operator::1220abc…',
        'compliance' => 'dtcc-compliance::1220abc…',
        'registrar' => 'dtcc-registrar::1220abc…',
        'clientOnboarder' => 'dtcc-onboarder::1220abc…',
        'upgrader' => 'dtcc-upgrader::1220abc…'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/operations/canton/calls"

	payload := strings.NewReader("{\n  \"type\": \"DTCC_PARTICIPANT_ONBOARDING\",\n  \"vaultAccountId\": \"12\",\n  \"blockchainId\": \"CANTON\",\n  \"payload\": {\n    \"expiresAt\": \"2026-12-31T23:59:59Z\",\n    \"operator\": \"dtcc-operator::1220abc…\",\n    \"compliance\": \"dtcc-compliance::1220abc…\",\n    \"registrar\": \"dtcc-registrar::1220abc…\",\n    \"clientOnboarder\": \"dtcc-onboarder::1220abc…\",\n    \"upgrader\": \"dtcc-upgrader::1220abc…\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireblocks.io/v1/operations/canton/calls")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"DTCC_PARTICIPANT_ONBOARDING\",\n  \"vaultAccountId\": \"12\",\n  \"blockchainId\": \"CANTON\",\n  \"payload\": {\n    \"expiresAt\": \"2026-12-31T23:59:59Z\",\n    \"operator\": \"dtcc-operator::1220abc…\",\n    \"compliance\": \"dtcc-compliance::1220abc…\",\n    \"registrar\": \"dtcc-registrar::1220abc…\",\n    \"clientOnboarder\": \"dtcc-onboarder::1220abc…\",\n    \"upgrader\": \"dtcc-upgrader::1220abc…\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/operations/canton/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"DTCC_PARTICIPANT_ONBOARDING\",\n  \"vaultAccountId\": \"12\",\n  \"blockchainId\": \"CANTON\",\n  \"payload\": {\n    \"expiresAt\": \"2026-12-31T23:59:59Z\",\n    \"operator\": \"dtcc-operator::1220abc…\",\n    \"compliance\": \"dtcc-compliance::1220abc…\",\n    \"registrar\": \"dtcc-registrar::1220abc…\",\n    \"clientOnboarder\": \"dtcc-onboarder::1220abc…\",\n    \"upgrader\": \"dtcc-upgrader::1220abc…\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "transactionId": "5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21",
  "status": "SUBMITTED"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json

type

enum<string>

required

Which call to make. Selects the shape of payload.

Available options:

DTCC_PARTICIPANT_ONBOARDING

Example:

"DTCC_PARTICIPANT_ONBOARDING"

vaultAccountId

string

required

The vault account whose Canton wallet makes this call.

Example:

"12"

blockchainId

enum<string>

required

The blockchain the vault account's Canton party is connected to — CANTON or CANTON_TEST.

Available options:

CANTON,

CANTON_TEST

Example:

"CANTON"

payload

object

Optional, and so is every field in it: omit payload entirely to onboard with DTCC's published parties for the blockchain and the default expiry.

Show child attributes

Response

The outgoing transaction that carries the call.

transactionId

string

required

The outgoing transaction that carries the call.

Example:

"5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21"

status

string

required

The transaction's status at the time of this response — SUBMITTED.

Example:

"SUBMITTED"

⌘I

Make a Canton call

curl --request POST \
  --url https://api.fireblocks.io/v1/operations/canton/calls \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "DTCC_PARTICIPANT_ONBOARDING",
  "vaultAccountId": "12",
  "blockchainId": "CANTON",
  "payload": {
    "expiresAt": "2026-12-31T23:59:59Z",
    "operator": "dtcc-operator::1220abc…",
    "compliance": "dtcc-compliance::1220abc…",
    "registrar": "dtcc-registrar::1220abc…",
    "clientOnboarder": "dtcc-onboarder::1220abc…",
    "upgrader": "dtcc-upgrader::1220abc…"
  }
}
'

import requests

url = "https://api.fireblocks.io/v1/operations/canton/calls"

payload = {
    "type": "DTCC_PARTICIPANT_ONBOARDING",
    "vaultAccountId": "12",
    "blockchainId": "CANTON",
    "payload": {
        "expiresAt": "2026-12-31T23:59:59Z",
        "operator": "dtcc-operator::1220abc…",
        "compliance": "dtcc-compliance::1220abc…",
        "registrar": "dtcc-registrar::1220abc…",
        "clientOnboarder": "dtcc-onboarder::1220abc…",
        "upgrader": "dtcc-upgrader::1220abc…"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'DTCC_PARTICIPANT_ONBOARDING',
    vaultAccountId: '12',
    blockchainId: 'CANTON',
    payload: {
      expiresAt: '2026-12-31T23:59:59Z',
      operator: 'dtcc-operator::1220abc…',
      compliance: 'dtcc-compliance::1220abc…',
      registrar: 'dtcc-registrar::1220abc…',
      clientOnboarder: 'dtcc-onboarder::1220abc…',
      upgrader: 'dtcc-upgrader::1220abc…'
    }
  })
};

fetch('https://api.fireblocks.io/v1/operations/canton/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/operations/canton/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'DTCC_PARTICIPANT_ONBOARDING',
    'vaultAccountId' => '12',
    'blockchainId' => 'CANTON',
    'payload' => [
        'expiresAt' => '2026-12-31T23:59:59Z',
        'operator' => 'dtcc-operator::1220abc…',
        'compliance' => 'dtcc-compliance::1220abc…',
        'registrar' => 'dtcc-registrar::1220abc…',
        'clientOnboarder' => 'dtcc-onboarder::1220abc…',
        'upgrader' => 'dtcc-upgrader::1220abc…'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/operations/canton/calls"

	payload := strings.NewReader("{\n  \"type\": \"DTCC_PARTICIPANT_ONBOARDING\",\n  \"vaultAccountId\": \"12\",\n  \"blockchainId\": \"CANTON\",\n  \"payload\": {\n    \"expiresAt\": \"2026-12-31T23:59:59Z\",\n    \"operator\": \"dtcc-operator::1220abc…\",\n    \"compliance\": \"dtcc-compliance::1220abc…\",\n    \"registrar\": \"dtcc-registrar::1220abc…\",\n    \"clientOnboarder\": \"dtcc-onboarder::1220abc…\",\n    \"upgrader\": \"dtcc-upgrader::1220abc…\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireblocks.io/v1/operations/canton/calls")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"DTCC_PARTICIPANT_ONBOARDING\",\n  \"vaultAccountId\": \"12\",\n  \"blockchainId\": \"CANTON\",\n  \"payload\": {\n    \"expiresAt\": \"2026-12-31T23:59:59Z\",\n    \"operator\": \"dtcc-operator::1220abc…\",\n    \"compliance\": \"dtcc-compliance::1220abc…\",\n    \"registrar\": \"dtcc-registrar::1220abc…\",\n    \"clientOnboarder\": \"dtcc-onboarder::1220abc…\",\n    \"upgrader\": \"dtcc-upgrader::1220abc…\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/operations/canton/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"DTCC_PARTICIPANT_ONBOARDING\",\n  \"vaultAccountId\": \"12\",\n  \"blockchainId\": \"CANTON\",\n  \"payload\": {\n    \"expiresAt\": \"2026-12-31T23:59:59Z\",\n    \"operator\": \"dtcc-operator::1220abc…\",\n    \"compliance\": \"dtcc-compliance::1220abc…\",\n    \"registrar\": \"dtcc-registrar::1220abc…\",\n    \"clientOnboarder\": \"dtcc-onboarder::1220abc…\",\n    \"upgrader\": \"dtcc-upgrader::1220abc…\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "transactionId": "5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21",
  "status": "SUBMITTED"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Make a Canton call

Headers

Body

Response