Skip to content

Reference

ledger.interactiveSubmissionAllocateParty

POST /v2/interactive-submission/allocate-party — allocate party metadata interactively.

Wraps POST /v2/interactive-submission/allocate-party with InteractiveSubmissionAllocatePartyParams (optional partyIdHint, displayName, isLocal pieces mirrored into JSON).

Receiver: await canton.ledger.interactiveSubmissionAllocateParty

Setup

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

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

Minimal example

const party = await canton.ledger.interactiveSubmissionAllocateParty({
  partyIdHint: 'alice-interactive',
  displayName: 'Alice',
  isLocal: true,
});

Parameters — InteractiveSubmissionAllocatePartyParams

Optional strings/boolean knobs aligning with InteractiveSubmissionAllocatePartyParamsSchema.

Returns — InteractiveSubmissionAllocatePartyResponse

Includes party record (party, displayName, isLocal).

Errors and pitfalls

Interactive endpoints honor Canton routing gates—ensure participant exposes interactive submission.

Auth and party

Same bearer authorization envelope as other ledger REST surfaces.

See also

Source

operations/v2/interactive-submission/allocate-party.ts