---
title: "PartyUpdate"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/PartyUpdate"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# PartyUpdate

A single party change entry (pa-bpm-txn-common PartyUpdateDto). One MultiPartyRoleChangeRequest carries a list of these - one per party being added, updated, or removed in this transaction.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.9
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    PartyUpdateAction:
      type: string
      description: Action to apply for this party update entry
      enum:
        - ADD
        - UPDATE
        - DELETE
        - NONE
      example: ADD
    PartyDetailsForPartyRole:
      type: object
      description: >
        Full party detail payload (pa-bpm-txn-common
        PartyDetailsForPartyRoleDto).

        Only the fields relevant to the action/party role need to be populated.
      properties:
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        timestamp:
          type: string
        customerId:
          type: string
        partyId:
          type: string
          description: |
            Party identifier. Required for UPDATE/DELETE actions; omit (or leave
            null) for ADD so the carrier assigns one. Defaults to a random UUID
            client-side if not explicitly set - always set explicitly for
            UPDATE/DELETE.
        parentPartyId:
          type: string
          description: Parent party identifier (e.g. for a minor's guardian relationship)
        partyType:
          type: string
        partyStatus:
          type: string
        beneficiaryPercentage:
          type: integer
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        fullName:
          type: string
        prefix:
          type: string
        suffix:
          type: string
        gender:
          type: string
        genderIdentity:
          type: string
        dateOfBirth:
          type: string
          format: date
        attainedAge:
          type: integer
        birthCountry:
          type: string
        citizenCountry:
          type: string
        birthState:
          type: string
        doingBusinessAs:
          type: string
        abbreviatedName:
          type: string
        organizationCode:
          type: string
        entityType:
          type: string
        trustDate:
          type: string
          format: date
        trustType:
          type: string
        trustTitle:
          type: string
        trustAccessCode:
          type: string
        amendedTrustDate:
          type: string
          format: date
        governingStateOfTrust:
          type: string
        preferredCommunicationType:
          type: string
        preferredAddressIndicator:
          type: string
        identifications:
          type: array
          items:
            $ref: "#/components/schemas/PartyRoleChangeIdentification"
        addresses:
          type: array
          items:
            $ref: "#/components/schemas/PartyRoleChangeAddress"
        phones:
          type: array
          items:
            $ref: "#/components/schemas/PartyRoleChangePhone"
        emails:
          type: array
          items:
            $ref: "#/components/schemas/PartyRoleChangeEmail"
        bankDetails:
          type: array
          items:
            $ref: "#/components/schemas/PartyRoleChangeBankDetails"
        version:
          type: string
        agentExternalId:
          type: string
        agentType:
          type: string
        agentPercentage:
          type: number
          format: double
        partyPercentage:
          type: number
          format: double
        collateralAmount:
          type: number
          format: double
        deathDetails:
          $ref: "#/components/schemas/PartyRoleChangeDeathDetails"
        impairmentDetails:
          $ref: "#/components/schemas/PartyRoleChangeImpairmentDetails"
        isPartyBeneficiaryNonNatural:
          type: boolean
        isIrrevocable:
          type: boolean
        isRequiredMinimumDistributionDesignated:
          type: boolean
        preferredAddressId:
          type: string
        preferredEmailId:
          type: string
        preferredPhoneId:
          type: string
        isAddressSameAsOwner:
          type: string
    PartyRoleChangeIdentification:
      type: object
      properties:
        identificationType:
          type: string
          example: SSN
        identificationValue:
          type: string
          example: "123456789"
        issueState:
          type: string
          description: State of issue (e.g. AL)
        issueCountry:
          type: string
          description: Country of issue (e.g. US)
        identificationId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        identificationKey:
          type: string
        identificationDescription:
          type: string
    PartyRoleChangeAddress:
      type: object
      properties:
        addressId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        addressType:
          type: string
          example: HOME
        addressLine1:
          type: string
        addressLine2:
          type: string
        addressLine3:
          type: string
        city:
          type: string
        state:
          type: string
        zipCode:
          type: string
        zipCodeExtension:
          type: string
        country:
          type: string
        isPreferred:
          type: boolean
    PartyRoleChangePhone:
      type: object
      properties:
        phoneId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        phoneType:
          type: string
        countryCode:
          type: string
        areaCode:
          type: string
        dialNumber:
          type: string
        extension:
          type: string
        bestTime:
          type: string
        timeZone:
          type: string
        preferredPhoneIndicator:
          type: string
        isPreferred:
          type: boolean
    PartyRoleChangeEmail:
      type: object
      properties:
        emailId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        emailType:
          type: string
        emailAddress:
          type: string
        preferredEmailIndicator:
          type: string
        isPreferred:
          type: boolean
    PartyRoleChangeBankDetails:
      type: object
      description: Bank details associated with a party
      properties:
        bankId:
          type: string
        appliesToPartyId:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        nameOnAccount:
          type: string
        accountStatus:
          type: string
        accountType:
          type: string
        accountSubType:
          type: string
        accountNumber:
          type: string
        routingNumber:
          type: string
        internationalBankAccountNumber:
          type: string
        branchName:
          type: string
        branchAddress:
          $ref: "#/components/schemas/PartyRoleChangeAddress"
        branchPhoneNumber:
          type: string
        bankAccountPurpose:
          type: string
    PartyRoleChangeDeathDetails:
      type: object
      properties:
        dateOfDeath:
          type: string
          format: date
        causeOfDeath:
          type: string
        deathNotificationDate:
          type: string
          format: date
        dateOfDueProof:
          type: string
          format: date
    PartyRoleChangeImpairmentDetails:
      type: object
      properties:
        disabled:
          type: boolean
        disabilityStartDate:
          type: string
          format: date
    PartyUpdate:
      type: object
      description: >
        A single party change entry (pa-bpm-txn-common PartyUpdateDto). One

        MultiPartyRoleChangeRequest carries a list of these - one per party
        being

        added, updated, or removed in this transaction.
      properties:
        action:
          $ref: "#/components/schemas/PartyUpdateAction"
        customerId:
          type: string
          description: Top-level customer ID. Sent alongside party.customerId for the same
            party.
        relationshipToParty:
          type: string
        partyRole:
          type: string
          description: >
            The specific party role for this entry. Each backing microservice
            sends

            its own literal value today, with no shared casing convention across

            services (tracked for future normalization): PAYEE (payee-change),

            TRUSTEE (trustee-change), ATTORNEY_IN_FACT (poa-change),

            AuthorizedSignatory (authorized-signatory-change), Owner /
            JointOwner

            (owner-mgmt), CoverageJointInsured (rider-role-change).
          example: CoverageJointInsured
        referencePartyId:
          type: string
          description: >
            PartyId of an existing party on the policy to clone when adding a
            new

            party (e.g. ADD a new Coverage Joint Insured with the same details
            as

            an existing party). Only relevant for action ADD; not forwarded to

            downstream carrier systems.
        partyStatus:
          type: string
        carrierDecision:
          type: string
        rejectionReason:
          type: string
        delegatedExecutionAuthorityType:
          type: string
          description: Power of Attorney specific - delegated execution authority type
        powerOfAttorneyAccessLevelType:
          type: string
          description: Power of Attorney specific - access level type
        party:
          $ref: "#/components/schemas/PartyDetailsForPartyRole"
      required:
        - action
```