Skip to main content
Business Accounts are in early access. See the overview for the model.
Create a business account as an authenticated user. You become the owner, and can then add wallets, signers, and members.

Create an account

create takes an optional name, externalRef, and metadata, and returns the new account.
String?
Display name for the account.
String?
A developer-supplied label for mapping your own org or tenant ID onto this account. Not unique, so multiple accounts may share a value.
Map<String, dynamic>?
Arbitrary key-value metadata stored alongside the account.
The returned BusinessAccount has id, name, externalRef, metadata, projectEnvironmentId, createdAt, and updatedAt.

List accounts

list returns the accounts the current user is a member of, for the active environment. Pass externalRefs to filter by your own org or tenant IDs.
BusinessAccountList returns items plus a nextCursor for paging.

Read one account

get returns the account plus its members, signers, and wallets.
Each entry in detail.wallets is a BusinessAccountWalletSummary with id, chain, and publicKey. Use the id when you add or remove wallets and when you manage signers.
Only members of an account can read it. A request from a non-member returns 404 rather than 403, so account existence is not leaked across tenants.

Rename an account

update changes the account name.

On error

Every method returns a Future that throws on failure. Wrap calls in try/catch and show the failure to the user:

Next steps

Add wallets

Link an embedded wallet to the account.

Members and roles

Add admins and viewers, and transfer ownership.
Last modified on August 20, 2026