• Utilities
  • Overview
    • Credential Utility
      • Introduction
      • Onboarding & Offboarding
      • Free Credentials
      • Paid Credentials
      • Service Monetization via Paid Credentials
    • Registry Utility
      • Introduction
      • Onboarding & Offboarding
      • Workflows
      • Token Standard integration
      • Featured App Activity Markers
    • Commercial Agreement
    • Auto TopUp Application
    • Collateral Utility
      • Create a collateral agreement
      • Settle a margin call
  • Setup
    • Prerequisites
    • Install (Kubernetes)
    • Install (Docker Compose)
    • Ingress
    • Getting Started
  • Tutorials
    • Issuing Tokenized Instruments
      • Introduction
      • 1. Onboarding roles in Registry
      • 2. Credential Preparation for Token Issuance and Transfer
      • 3. Token Issuance
    • Transferring Tokenized Instruments
      • Introduction
      • 1. Onboarding roles in Registry
      • 2. Credential Preparation for Token Transfer
      • 3. Token Transfer
    • Redeeming Tokenized Instruments
      • Introduction
      • 1. Token Redemption
  • How Tos
    • Registry Utility / Retrieve Holdings
    • Registry Utility / Transfer
    • Registry Utility / Mint
    • Registry Utility / Burn
  • Reference
    • DAR Versions
    • API Reference
      • Commercials API
        • Utility.Commercials
          • Utility.Commercials.V0.Model.CommercialAgreement
          • Utility.Commercials.V0.Model.Offer
          • Utility.Commercials.V0.Model.Types
      • Credential API
        • Utility.Credential
          • Utility.Credential.V0.Credential
        • Utility.Credential.App
          • Utility.Credential.App.V0.Model.Billing
          • Utility.Credential.App.V0.Model.Offer
          • Utility.Credential.App.V0.Service.Operator
          • Utility.Credential.App.V0.Service.User
          • Utility.Credential.App.V0.Types
          • Utility.Credential.App.V0.Util
      • Registry API
        • Utility.Registry
          • Utility.Registry.V0.Configuration.AppReward
          • Utility.Registry.V0.Configuration.Instrument
          • Utility.Registry.V0.Holding.Allocation
          • Utility.Registry.V0.Holding.Burn
          • Utility.Registry.V0.Holding.Lock
          • Utility.Registry.V0.Holding.Mint
          • Utility.Registry.V0.Holding.Transfer
          • Utility.Registry.V0.Holding.Unlock
          • Utility.Registry.V0.Rule.Transfer
          • Utility.Registry.V0.Types
          • Utility.Registry.V0.Util
        • Utility.Registry.App
          • Utility.Registry.App.V0.Configuration.Operator
          • Utility.Registry.App.V0.Configuration.Provider
          • Utility.Registry.App.V0.Model.Burn
          • Utility.Registry.App.V0.Model.Mint
          • Utility.Registry.App.V0.Model.Transfer
          • Utility.Registry.App.V0.Service.AllocationFactory
          • Utility.Registry.App.V0.Service.Holder
          • Utility.Registry.App.V0.Service.Provider
          • Utility.Registry.App.V0.Service.Registrar
        • Utility.Holding
          • Utility.Registry.Holding.V0.Holding
          • Utility.Registry.Holding.V0.Types
      • Settlement Utility API
        • Utility.Settlement.App
          • Utility.Settlement.App.V1.Model.Configuration.Operator
          • Utility.Settlement.App.V1.Model.Dvp
          • Utility.Settlement.App.V1.Service.User
          • Utility.Settlement.App.V1.Types
      • Collateral Utility API
        • Utility.Collateral.App
          • Utility.Collateral.App.Model.Collateral
          • Utility.Collateral.App.Model.Configuration.Operator
          • Utility.Collateral.App.Model.State
          • Utility.Collateral.App.Service.User
          • Utility.Collateral.App.Types
    • Operator Backend API
Back to Home
  • Overview
    • Credential Utility
      • Introduction
      • Onboarding & Offboarding
      • Free Credentials
      • Paid Credentials
      • Service Monetization via Paid Credentials
    • Registry Utility
      • Introduction
      • Onboarding & Offboarding
      • Workflows
      • Token Standard integration
      • Featured App Activity Markers
    • Commercial Agreement
    • Auto TopUp Application
    • Collateral Utility
      • Create a collateral agreement
      • Settle a margin call
  • Setup
    • Prerequisites
    • Install (Kubernetes)
    • Install (Docker Compose)
    • Ingress
    • Getting Started
  • Tutorials
    • Issuing Tokenized Instruments
      • Introduction
      • 1. Onboarding roles in Registry
      • 2. Credential Preparation for Token Issuance and Transfer
      • 3. Token Issuance
    • Transferring Tokenized Instruments
      • Introduction
      • 1. Onboarding roles in Registry
      • 2. Credential Preparation for Token Transfer
      • 3. Token Transfer
    • Redeeming Tokenized Instruments
      • Introduction
      • 1. Token Redemption
  • How Tos
    • Registry Utility / Retrieve Holdings
    • Registry Utility / Transfer
    • Registry Utility / Mint
    • Registry Utility / Burn
  • Reference
    • DAR Versions
    • API Reference
      • Commercials API
        • Utility.Commercials
          • Utility.Commercials.V0.Model.CommercialAgreement
          • Utility.Commercials.V0.Model.Offer
          • Utility.Commercials.V0.Model.Types
      • Credential API
        • Utility.Credential
          • Utility.Credential.V0.Credential
        • Utility.Credential.App
          • Utility.Credential.App.V0.Model.Billing
          • Utility.Credential.App.V0.Model.Offer
          • Utility.Credential.App.V0.Service.Operator
          • Utility.Credential.App.V0.Service.User
          • Utility.Credential.App.V0.Types
          • Utility.Credential.App.V0.Util
      • Registry API
        • Utility.Registry
          • Utility.Registry.V0.Configuration.AppReward
          • Utility.Registry.V0.Configuration.Instrument
          • Utility.Registry.V0.Holding.Allocation
          • Utility.Registry.V0.Holding.Burn
          • Utility.Registry.V0.Holding.Lock
          • Utility.Registry.V0.Holding.Mint
          • Utility.Registry.V0.Holding.Transfer
          • Utility.Registry.V0.Holding.Unlock
          • Utility.Registry.V0.Rule.Transfer
          • Utility.Registry.V0.Types
          • Utility.Registry.V0.Util
        • Utility.Registry.App
          • Utility.Registry.App.V0.Configuration.Operator
          • Utility.Registry.App.V0.Configuration.Provider
          • Utility.Registry.App.V0.Model.Burn
          • Utility.Registry.App.V0.Model.Mint
          • Utility.Registry.App.V0.Model.Transfer
          • Utility.Registry.App.V0.Service.AllocationFactory
          • Utility.Registry.App.V0.Service.Holder
          • Utility.Registry.App.V0.Service.Provider
          • Utility.Registry.App.V0.Service.Registrar
        • Utility.Holding
          • Utility.Registry.Holding.V0.Holding
          • Utility.Registry.Holding.V0.Types
      • Settlement Utility API
        • Utility.Settlement.App
          • Utility.Settlement.App.V1.Model.Configuration.Operator
          • Utility.Settlement.App.V1.Model.Dvp
          • Utility.Settlement.App.V1.Service.User
          • Utility.Settlement.App.V1.Types
      • Collateral Utility API
        • Utility.Collateral.App
          • Utility.Collateral.App.Model.Collateral
          • Utility.Collateral.App.Model.Configuration.Operator
          • Utility.Collateral.App.Model.State
          • Utility.Collateral.App.Service.User
          • Utility.Collateral.App.Types
    • Operator Backend API

API Examples¶

This section contains examples on how to use the HTTP LEDGER JSON API to interact with the Registry Utility in practice. It is not intended to be an extensive guide, but rather a starting point for developers to get familiar with the API.

  • Registry Utility / Retrieve Holdings
    • Prerequisites
    • Preparation
    • Retrieve Holdings
      • 1. Obtain the Ledger End Offset
      • 2. Retrieve Utility Holdings
      • 3. Retrieve Canton Network Token Standard Holdings
  • Registry Utility / Transfer
    • Preparation
      • Step 1: Sender Offers a Transfer
      • Step 2: Receiver Accepts the Transfer Offer
  • Registry Utility / Mint
    • Preparation
      • Step 1: Minter Requests a Mint
      • Step 2: Admin Accepts Mint Request
  • Registry Utility / Burn
    • Preparation
      • Step 1: Burner Requests a Burn
      • Step 2: Admin Accepts Burn Reequest

Copyright (c) 2025 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved. Any unauthorized use, duplication or distribution is strictly prohibited. "Digital Asset" and "Daml" are Registered in the U.S. Patent and Trademark Office.