allocateExternalParty wraps ledgerClient.allocateExternalParty with synchronizer, identityProviderId, onboardingTransactions, multiHashSignatures.
Typically invoked after generateExternalPartyTopology + signing workflow (createExternalParty composes these automatically).
Setup
import { allocateExternalParty } from '@fairmint/canton-node-sdk';
const canton = new Canton({
network: 'NETWORK_NAME',
partyId: 'PARTY_ID',
});Minimal example
await allocateExternalParty({
ledgerClient: canton.ledger,
synchronizerId: 'SYNCHRONIZER_ID',
identityProviderId: 'IDENTITY_PROVIDER_ID',
onboardingTransactions: [{ transaction: 'BASE64_TX' }],
multiHashSignatures: SIGNATURES_PLACEHOLDER,
});Parameters
AllocateExternalPartyOptions — mirrors ledger operation:
ledgerClient(required)synchronizerId(required)identityProviderId(required)onboardingTransactions(optional)multiHashSignatures(optional)
Returns
Promise<AllocateExternalPartyResponse> — Ledger allocate payload (partyId, etc.).
Errors
Propagates ApiError from allocateExternalParty.
Auth and party
Requires ledger credentials authorized for external-party onboarding endpoints.