> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canton.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Details and history

> An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.

<p class="x2mdx-ref-back"><a href="/reference/wallet-gateway-json-rpc/index">Back to overview</a></p>

<div class="x2mdx-ref-hero">
  <p class="x2mdx-ref-eyebrow">OpenRPC Spec</p>

  <h1 class="x2mdx-ref-title">Signing API</h1>

  <p class="x2mdx-ref-summary">An OpenRPC specification for the Signing API which allows the Wallet Gateway to interact with a Wallet Providers.</p>

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
  </div>

  <dl class="x2mdx-ref-meta-grid">
    <div class="x2mdx-ref-meta-item">
      <dt>Latest source path</dt>
      <dd>api-specs/openrpc-signing-api.json</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>Publish version</dt>
      <dd>1.4.0</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>OpenRPC version</dt>
      <dd>1.2.6</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>Spec info.version</dt>
      <dd>0.1.0</dd>
    </div>
  </dl>
</div>

## Methods

Method pages are the primary reference surface. This spec page stays focused on grouping and discovery.

<div class="x2mdx-ref-card-grid">
  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/createkey">
    <div class="x2mdx-ref-card-head">
      <h3>createKey</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Create a new key at the Wallet Provider.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/getconfiguration">
    <div class="x2mdx-ref-card-head">
      <h3>getConfiguration</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/getkeys">
    <div class="x2mdx-ref-card-head">
      <h3>getKeys</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Get a list of public keys availabile for signing.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/gettransaction">
    <div class="x2mdx-ref-card-head">
      <h3>getTransaction</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Get the status of a single transaction by its ID.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/gettransactions">
    <div class="x2mdx-ref-card-head">
      <h3>getTransactions</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Get the status of multiple transactions, filtering by txIds or publicKeys. Either publicKeys or txIds must be provided.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/setconfiguration">
    <div class="x2mdx-ref-card-head">
      <h3>setConfiguration</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Set configuration parameters for the Wallet Provider. The paramaters will change depending on the Wallet Provider implementation</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/signmessage">
    <div class="x2mdx-ref-card-head">
      <h3>signMessage</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 1.4.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Signs an arbitrary UTF-8 message with the wallet's private key (Ed25519). The message bytes are signed as-is; callers are expected to embed any application-level domai...</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/signtransaction">
    <div class="x2mdx-ref-card-head">
      <h3>signTransaction</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Uses the Wallet Provider to sign a transaction. This will likely be an asynchronous operation.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/signing-api/subscribetransactions">
    <div class="x2mdx-ref-card-head">
      <h3>subscribeTransactions</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Subscribe to updates for specific transactions. The server will emit updates when the status of the specified transactions have changed. On initial subscription, the s...</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>
</div>