Party Management

Parties represent the organisations that interact with risks on the Send Workbench platform. The most common type is a broker — the intermediary that places risks on behalf of their clients. Party configuration controls how these organisations appear in the UI, how they are identified, and how they are associated with risks.

Party file location

Each party is defined in its own JSON file:

config/{client}/party/{name}.json

The filename just needs to be a meaningful identifier for the party — it does not need to match the domain name. For example, marsh.json is fine even though the domainName is marsh.com.

File structure

{
  "company": {
    "name": "Marsh",
    "displayName": "Marsh",
    "domainName": "marsh.com",
    "email": "info@marsh.com",
    "telephoneNumber": "+44 2012 876543",
    "importance": 2,
    "addresses": [
      {
        "addressType": "REGISTERED",
        "addressLine1": "1 Tower Place West",
        "city": "London",
        "postcode": "EC3R 5BU",
        "country": "UK",
        "countryCode": "GB"
      }
    ],
    "companyIdentifiers": [
      {
        "companyIdentifierCodeType": "DOMESTIC_COMPANY_NUMBER",
        "code": "01507274"
      }
    ]
  },
  "partyType": "BROKER"
}

Field reference

Top-level fields

Field	Required	Description
partyType	Yes	The role of this party. Use BROKER for broker organisations.
company	Yes	Nested object containing all company details (see below).

company fields

Field	Required	Description
name	Yes	The legal or full name of the organisation. Used internally.
displayName	Yes	The name shown in the Workbench UI. Can differ from name (e.g. shorter or more recognisable form).
domainName	Yes	The organisation's internet domain (e.g. marsh.com). Used to identify and match the party. No protocol prefix — bare domain only.
email	Yes	General contact email for the party.
telephoneNumber	Yes	General contact telephone number.
importance	No	Numeric value controlling sort order or prominence in the UI. Lower numbers indicate higher importance (e.g. 1 = highest).
addresses	Yes	Array of address objects (see below).
companyIdentifiers	No	Array of identifier objects for regulatory or company reference numbers (see below).

addresses object

Field	Description
addressType	Type of address. Use REGISTERED for the company's registered office.
addressLine1	First line of the address.
city	City name.
postcode	Postcode or ZIP code.
country	Country name (free text).
countryCode	ISO 3166-1 alpha-2 country code (e.g. GB, US).

companyIdentifiers object

Field	Description
companyIdentifierCodeType	Type of identifier. DOMESTIC_COMPANY_NUMBER is used for Companies House registration numbers in the UK.
code	The actual identifier value (e.g. Companies House number).

The domainName field

company.domainName is the key identifier for a party. It should be set to the organisation's primary internet domain — the same domain used for their email addresses (e.g. if brokers have emails at @marsh.com, the domainName is marsh.com).

This field is used by the platform to:

• Uniquely identify the party across the system
• Associate broker users with the correct party based on their email domain
• Match incoming data or integrations to the correct party record

Rules: - Use the bare domain only — no https://, no trailing slash - Each party must have a unique domainName

Adding a new broker party

1. Create a new file at config/{client}/party/{domain}.json
2. Populate all required fields, using one of the existing files as a template
3. Set partyType to BROKER
4. Set domainName to the broker's email domain
5. Deploy the config

Example parties (send-senduk reference)

The send-senduk repository ships with the following pre-configured broker parties as reference:

File	displayName	domainName	importance
aon.com.json	AON	aon.com	1
marsh.com.json	Marsh	marsh.com	2
wtwco.com.json	Willis Towers Watson	wtwco.com	2
lockton.json	Lockton International	lockton.com	2
gallagher.json	Gallagher	gallagher.com	2
howden.json	Howden Insurance Brokers	howden.com	2
ardonagh.json	Ardonagh Specialty	ardonagh.com	2
miller.json	Miller Insurance Services	miller.com	2
bms.json	BMS	—	—
mcgill.json	McGill	—	—
amwins.json	Amwins	—	—
alliant.json	Alliant	—	—
tysers.json	Tysers	—	—

These are representative examples — copy and adapt them for the brokers relevant to your implementation.