> ## Documentation Index
> Fetch the complete documentation index at: https://cantonfoundation-issue-698-scan-api-single-page.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# User API

> An OpenRPC specification for the user to interact with the Wallet Gateway.

<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">User API</h1>

  <p class="x2mdx-ref-summary">An OpenRPC specification for the user to interact with the Wallet Gateway.</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-user-api.json</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>Publish version</dt>
      <dd>0.25.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/user-api/addidp">
    <div class="x2mdx-ref-card-head">
      <h3>addIdp</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">Adds a new identity 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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/addnetwork">
    <div class="x2mdx-ref-card-head">
      <h3>addNetwork</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">Adds a new network configuration (similar to EIP-3085).</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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/addsession">
    <div class="x2mdx-ref-card-head">
      <h3>addSession</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">Adds a network session.</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/user-api/allocatepartyforwallet">
    <div class="x2mdx-ref-card-head">
      <h3>allocatePartyForWallet</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">Allocates a party for an already initialized wallet if external signing is complete.</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/user-api/createwallet">
    <div class="x2mdx-ref-card-head">
      <h3>createWallet</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">Creates a new wallet and party with the given hint.</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/user-api/deletetransaction">
    <div class="x2mdx-ref-card-head">
      <h3>deleteTransaction</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">Deletes a pending transaction. Only transactions with status 'pending' can be deleted.</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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/execute">
    <div class="x2mdx-ref-card-head">
      <h3>execute</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">Executes a signed transaction.</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/user-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>

    <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/user-api/getuser">
    <div class="x2mdx-ref-card-head">
      <h3>getUser</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">Returns information about the current user, including whether they are an admin.</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>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/iswalletsyncneeded">
    <div class="x2mdx-ref-card-head">
      <h3>isWalletSyncNeeded</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">Checks if wallet sync is needed (disabled wallets or new parties on ledger).</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>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/listidps">
    <div class="x2mdx-ref-card-head">
      <h3>listIdps</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/user-api/listnetworks">
    <div class="x2mdx-ref-card-head">
      <h3>listNetworks</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/user-api/listsessions">
    <div class="x2mdx-ref-card-head">
      <h3>listSessions</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/user-api/listtransactions">
    <div class="x2mdx-ref-card-head">
      <h3>listTransactions</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/user-api/listwallets">
    <div class="x2mdx-ref-card-head">
      <h3>listWallets</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">Lists wallets.</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>array\[object]</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/removeidp">
    <div class="x2mdx-ref-card-head">
      <h3>removeIdp</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">Removes an identity provider. Fails if an existing network is using the identity 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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/removenetwork">
    <div class="x2mdx-ref-card-head">
      <h3>removeNetwork</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">Removes a new network configuration (similar to EIP-3085).</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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/removesession">
    <div class="x2mdx-ref-card-head">
      <h3>removeSession</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">Removes the current network session.</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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/removewallet">
    <div class="x2mdx-ref-card-head">
      <h3>removeWallet</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">Removes a party with the given hint.</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/user-api/setprimarywallet">
    <div class="x2mdx-ref-card-head">
      <h3>setPrimaryWallet</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">Sets the specified wallet as the primary wallet for dApp usage.</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>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/user-api/sign">
    <div class="x2mdx-ref-card-head">
      <h3>sign</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">Signs the provided data with the private key of the specified or active party.</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/user-api/syncwallets">
    <div class="x2mdx-ref-card-head">
      <h3>syncWallets</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">Synchronizes wallets with the connected network.</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>object</dd>
      </div>
    </dl>
  </a>
</div>