Skip to main content
Version: 1.16.1

Type Alias: PartyId

PartyId = string & { [partyIdBrand]: true; }

Defined in: canton/addressCodec.ts:21

Branded Canton party ID (hint::1220<64-hex-fingerprint>, not a 3-part instrument id).

At runtime this is a plain string; the brand guarantees that every value of this type has been validated by parsePartyId — it is always non-empty and matches the Canton party ID format. Being a string subtype, a PartyId can be used anywhere a plain string is expected.

Type Declaration​

[partyIdBrand]​

readonly [partyIdBrand]: true