Skip to content

Reference

getUserStatus

GET wallet user-status — onboarding, wallet installation, and readiness flags derived from validator wallet OpenAPI.

getUserStatus answers whether downstream wallet RPCs (getWalletBalance, transfers) are meaningful yet—surface spinner UX until installation completes successfully.

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Import and receiver

import { Canton } from '@fairmint/canton-node-sdk';

Receiver: canton.validator.getUserStatus.

Minimal example

const status = await canton.validator.getUserStatus();

Parameters

None.

Returns

Wallet JSON bundle enumerating onboarding progression states—inspect canonical wallet-internal OpenAPI artifact packaged beside canton-node-sdk releases for authoritative field names (wallet_installed, etc.).

Errors and pitfalls

  • Treat transient HTTP failures distinctly from logical “not onboarded” responses—retry network stack separately.

Auth and party

Bearer token identifying Canton wallet personas provisioned previously registerNewUser.

See also

Source

src/clients/validator-api/operations/v0/wallet/get-user-status.ts on GitHub.