Create a Business Account

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. Business account functions are exported from @dynamic-labs-sdk/client/waas, and the matching React hooks from @dynamic-labs-sdk/react-hooks.

Prerequisites

A Dynamic client initialized with your environment ID (see Creating a Dynamic Client)
An authenticated user, because account operations act on behalf of the signed-in user
Business Accounts enabled for your environment

Create an account

createBusinessAccount takes an optional name, externalRef, and metadata, and returns the new account. The caller becomes the owner.

JavaScript
React

import { createBusinessAccount } from '@dynamic-labs-sdk/client/waas';

const account = await createBusinessAccount({
  name: 'Acme Treasury',
  externalRef: 'org_acme_123',
});
// account.id  →  use this to add wallets, signers, and members

useCreateBusinessAccount returns a mutation — call mutate (or mutateAsync) to create.

import { useCreateBusinessAccount } from '@dynamic-labs-sdk/react-hooks';

const CreateAccount = () => {
  const { mutate, isPending } = useCreateBusinessAccount();

  return (
    <button
      onClick={() => mutate({ name: 'Acme Treasury', externalRef: 'org_acme_123' })}
      disabled={isPending}
    >
      Create account
    </button>
  );
};

string

Optional display name for the account.

string

A developer-supplied label for mapping your own org/tenant ID onto this account — the primary B2B2B2C integration key. Not unique; multiple accounts may share a value.

Record<string, unknown>

Arbitrary key-value metadata to store alongside the account.

List accounts

listBusinessAccounts returns the accounts the current user is a member of, for the active environment.

JavaScript
React

import { listBusinessAccounts } from '@dynamic-labs-sdk/client/waas';

const { items } = await listBusinessAccounts();

import { useListBusinessAccounts } from '@dynamic-labs-sdk/react-hooks';

const AccountList = () => {
  const { data, isLoading } = useListBusinessAccounts();
  if (isLoading) return null;
  return (
    <ul>
      {data?.items.map((a) => <li key={a.id}>{a.name ?? a.id}</li>)}
    </ul>
  );
};

Read one account

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

JavaScript
React

import { getBusinessAccount } from '@dynamic-labs-sdk/client/waas';

const detail = await getBusinessAccount({ businessAccountId: account.id });
// detail.members  · detail.signers  · detail.wallets

import { useGetBusinessAccount } from '@dynamic-labs-sdk/react-hooks';

const AccountDetail = ({ businessAccountId }: { businessAccountId: string }) => {
  const { data: detail } = useGetBusinessAccount({ businessAccountId });
  return <span>{detail?.wallets.length ?? 0} wallets</span>;
};

Only members of an account can read it. A non-member request returns 404 (not 403), so account existence isn’t leaked across tenants.

Learn

Implement

Create a Business Account

Prerequisites

Create an account

List accounts

Read one account

Next steps

Add wallets

Members & roles

​Prerequisites

​Create an account

​List accounts

​Read one account

​Next steps

Add wallets

Members & roles

Prerequisites

Create an account

List accounts

Read one account

Next steps