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

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

# ClaimParty

Beneficiary/party details used internally by notification-method update processing.

## 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:
    ClaimPhone:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        phoneType:
          type: string
          example: MOBILE
        countryCode:
          type: string
          example: "1"
        areaCode:
          type: string
          example: "973"
        dialNumber:
          type: string
          example: "7657890"
        extension:
          type: string
          nullable: true
        bestTime:
          type: string
          nullable: true
        timezone:
          type: string
          nullable: true
        phoneId:
          type: string
          example: "1"
        isPreferred:
          type: boolean
          example: true
    DistributionMethod:
      type: object
      properties:
        distributionMethodOption:
          type: string
          enum:
            - US_MAIL
            - DIRECT_DEPOSIT
            - BROKERAGE_ACCOUNT
            - EFT
            - WIRE
            - MANUAL_CHECK
            - EXPRESS_CHECK
            - CHECK
            - ACH
            - EXCHANGE
            - PREMIUMLOAN
            - CREDITCARD
            - DTCC
          example: DIRECT_DEPOSIT
        bankDetails:
          type: array
          items:
            $ref: "#/components/schemas/BankDetails"
        manualCheckAddress:
          type: boolean
          example: false
        isBankConfirmationLetterAvailable:
          type: boolean
          example: false
        isVoidCheckAvailable:
          type: boolean
          example: false
        isValidSecurityRequirements:
          type: boolean
          example: true
        mailingAddress:
          $ref: "#/components/schemas/ClaimFormAddress"
        usMailOption:
          type: string
          enum:
            - MAIL_CHECKS_TO_THE_OWNERS_ADDRESS_OF_RECORD
            - MAIL_CHECKS_TO_THE_ADDRESS_LISTED_BELOW
        dtccDetails:
          $ref: "#/components/schemas/ClaimDtccDetails"
    ClaimFormAddress:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        addressId:
          type: string
          example: "1"
        addressType:
          type: string
          example: RESIDENCE
        addressLine1:
          type: string
          example: 1112 Pickle Street
        addressLine2:
          type: string
          example: South Jersey
        addressLine3:
          type: string
          example: 1234 Post box
        city:
          type: string
          example: Garden City
        state:
          type: string
          example: NJ
        zipCode:
          type: string
          example: "67846"
        zipCodeExtension:
          type: string
          example: "23"
        country:
          type: string
          example: US
        isPreferred:
          type: boolean
          example: true
    PartyIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - SSN
            - EIN
            - TIN
        value:
          type: string
          example: 123-45-6789
        description:
          type: string
          example: Social Security Number
        source:
          type: string
          example: SSA
        issueDate:
          type: string
          format: date
          example: 2015-01-01
          description: Date (with pattern "yyyy-mm-dd")
        expirationDate:
          type: string
          format: date
          nullable: true
          example: 2070-01-01
          description: Date (with pattern "yyyy-mm-dd")
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
        countryOfIssue:
          type: string
          example: US
    BankDetails:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        bankLocation:
          type: string
          example: Newark, NJ
        bankTelephoneNumber:
          type: string
          example: 973-555-0100
        bankName:
          type: string
          example: First National Bank
        bankId:
          type: string
          example: BNK-10001
        routingNumber:
          type: string
          example: "021000021"
        bankAccountNumber:
          type: string
          example: "000123456789"
        accountType:
          type: string
          enum:
            - CHECKING
            - SAVINGS
            - CREDITCARDACCOUNT
            - DEBITCARDACCOUNT
            - BROKERAGEACCOUNT
            - CERTIFICATEOFDEPOSITACCOUNT
          example: CHECKING
        accountStatus:
          type: string
          example: ACTIVE
        nameOnAccount:
          type: string
          example: Jane Smith
        primaryAccount:
          type: boolean
          example: true
        branchName:
          type: string
          example: Newark Branch
        bankAccountPurposeEnum:
          type: string
          enum:
            - PREMIUMBILLING
            - LOANINTERESTBILLING
            - LOANPRINCIPALBILLING
            - DISBURSEMENTS
            - PAYOUT
            - ONETIMEPREMIUMBILLING
            - ONETIMEWIRE
            - OPERATING
          example: DISBURSEMENTS
        address:
          $ref: "#/components/schemas/ClaimAddress"
    ClaimDtccDetails:
      type: object
      properties:
        payeeName:
          type: string
          example: Jane Smith
        participantId:
          type: string
          example: DTCC-10001
        participantDesc:
          type: string
          example: Primary Participant
        contractBinNumber:
          type: string
          example: BIN-10001
    ClaimAddress:
      type: object
      properties:
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        addressId:
          type: string
          example: "1"
        addressType:
          type: string
          example: RESIDENCE
        addressLine1:
          type: string
          example: 1112 Pickle Street
        addressLine2:
          type: string
          example: South Jersey
        addressLine3:
          type: string
          example: 1234 Post box
        city:
          type: string
          example: Garden City
        state:
          type: string
          example: NJ
        zipCode:
          type: string
          example: "67846"
        zipCodeExtension:
          type: string
          example: "23"
        country:
          type: string
          example: US
        correspondenceOnly:
          type: boolean
          description: When true, this address is used for correspondence/mailing only and
            is excluded from updates to the system of record.
          example: false
        isPreferred:
          type: boolean
          example: true
    ClaimParty:
      type: object
      description: Beneficiary/party details used internally by notification-method
        update processing.
      properties:
        partyId:
          type: string
          example: e6954b3d-a0ef-47dc-ac49-046db6bc7da7
        partyRoleId:
          type: string
          example: PR-10045
        partyRole:
          type: string
          example: PRIMARYBENEFICIARY
        partyType:
          type: string
          example: INDIVIDUAL
        trustType:
          type: string
          example: INTERVIVOSTRUST
        prefix:
          type: string
          example: Ms.
        suffix:
          type: string
          example: Jr.
        firstName:
          type: string
          example: Jane
        middleName:
          type: string
          example: Marie
        lastName:
          type: string
          example: Smith
        fullName:
          type: string
          example: Jane Marie Smith
        gender:
          type: string
          example: FEMALE
        dateOfBirth:
          type: string
          format: date
          example: 1990-01-01
          description: Date (with pattern "yyyy-mm-dd")
        dateOfDeath:
          type: string
          format: date
          nullable: true
          description: Date (with pattern "yyyy-mm-dd")
        relationshipToInsured:
          type: string
          example: SPOUSE
        relationshipToParty:
          type: string
          example: SPOUSE
        beneficiaryPartyType:
          type: string
          example: PRIMARY
        beneficiaryPercentage:
          type: number
          format: double
          example: 50
        beneficiaryNetDeathBenefit:
          type: number
          format: double
          example: 100000
        beneficiaryState:
          type: string
          example: NJ
        residenceState:
          type: string
          example: NJ
        ssn:
          type: string
          example: 123-45-6789
        phone:
          $ref: "#/components/schemas/ClaimPhone"
        agentExternalId:
          type: string
          example: AGT10001
        taxIdentifierType:
          type: string
          example: SSN
        sorDistributionMethod:
          $ref: "#/components/schemas/DistributionMethod"
        formDistributionMethod:
          $ref: "#/components/schemas/DistributionMethod"
        action:
          type: string
          enum:
            - NONE
            - UPDATE
            - ADD
            - DELETE
          example: UPDATE
        residentAddress:
          $ref: "#/components/schemas/ClaimFormAddress"
        identifiers:
          type: array
          items:
            $ref: "#/components/schemas/PartyIdentifier"
        organizationCode:
          type: string
          example: ORG-10045
        entityType:
          type: string
          example: CORPORATION
        trustTitle:
          type: string
          example: Trustee
        trustDate:
          type: string
          format: date
          example: 2025-12-15
          description: Date (with pattern "yyyy-mm-dd")
        trustName:
          type: string
          example: The Smith Family Trust
        governingStateOfTrust:
          type: string
          example: NJ
        enityType:
          type: string
          enum:
            - SOLEPROPRIETORSHIP
            - GENERALPARTNERSHIP
            - LIMITEDPARTNERSHIP
            - CCORPORATION
            - SCORPORATION
            - LIMITEDLIABILITYCOMPANY
            - CHARITABLEORGANIZATION
            - ESTATE
            - TRUST
            - CORPORATION
            - INSURANCECOMPANY
            - UNKNOWN
          description: Mirrors the "entityType" field above; retained for backward
            compatibility with the source model.
          example: CORPORATION
```