Create a Business Account

Business Accounts are in early access. See Business Accounts for the model.

Create a business account as an authenticated user. You become the owner, and can then add wallets, signers, and members. Every business account operation lives on DynamicSDK.instance.businessAccounts.

Prerequisites

DynamicSDK initialized with your environment ID (see the quickstart)
An authenticated user, because account operations act on behalf of the signed-in user
Business Accounts enabled for your environment

Create an account

create takes an optional name, externalRef, and metadata, and returns the new account.

import 'package:dynamic_sdk/dynamic_sdk.dart';

final sdk = DynamicSDK.instance;

final account = await sdk.businessAccounts.create(
  name: 'Acme Treasury',
  externalRef: 'org_acme_123',
  metadata: {'tier': 'enterprise'},
);

print(account.id); // use this to add wallets, signers, and members

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.

final list = await sdk.businessAccounts.list();

for (final account in list.items ?? []) {
  print(account.name ?? account.id);
}

// Filter by your own references
final filtered = await sdk.businessAccounts.list(
  externalRefs: ['org_acme_123'],
);

BusinessAccountList returns items plus a nextCursor for paging.

Read one account

get returns the account plus its members, signers, and wallets.

final detail = await sdk.businessAccounts.get(
  businessAccountId: account.id,
);

print(detail.members.length);
print(detail.signers.length);
print(detail.wallets?.length ?? 0);

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.

final renamed = await sdk.businessAccounts.update(
  businessAccountId: account.id,
  name: 'Acme Operating Funds',
);

On error

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

try {
  final account = await sdk.businessAccounts.create(name: 'Acme Treasury');
  print(account.id);
} catch (e) {
  print('Failed to create business account: $e');
}

Learn

Cookbooks

Implement

Create a Business Account

Prerequisites

Create an account

List accounts

Read one account

Rename an account

On error

Next steps

Add wallets

Members and roles

​Prerequisites

​Create an account

​List accounts

​Read one account

​Rename an account

​On error

​Next steps

Add wallets

Members and roles

Prerequisites

Create an account

List accounts

Read one account

Rename an account

On error

Next steps