Proxy a request to the Canton Ledger API

Proxies a request to the Canton Ledger API associated with this wallet, using the validator’s OAuth2 credentials. Restricted to a curated allow-list of read-style resources. Used to satisfy the Canton WalletConnect canton_ledgerApi method.

POST /wallets/{walletId}/canton/ledger-api

Proxy a request to the Canton Ledger API

cURL

curl --request POST \
  --url https://api.dfns.io/wallets/{walletId}/canton/ledger-api \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource": "<string>",
  "body": "<unknown>"
}
'

Authentication

✅ Organization User (CustomerEmployee)
✅ Delegated User (EndUser)
✅ Service Account

Required Permissions

Wallets:Read: Always required.

Authorizations

Authorization · string · header · required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

walletId · string · required

Wallet id.

Required string length: 1 - 64

Body

application/json

requestMethod · enum<string> · required

The HTTP method used against the Canton Ledger API.

Available options: GET, POST

resource · string · required

The Canton Ledger API resource path, beginning with /v2/ (e.g. /v2/state/active-contracts).

Minimum string length: 1

body · any

Optional JSON body, forwarded verbatim for POST resources. Must be omitted for GET resources.

Response

200 - application/json

Success