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

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

# PolicyCoverageChangesParty

## 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:
    PolicyCoverageChangesPartyRole:
      type: string
      enum:
        - INSURED
        - OWNER
        - BENEFICIARY
        - PAYOR
        - TRUSTEE
      description: Role the party plays on the policy for this transaction
      example: INSURED
    PolicyCoverageChangesPersonalInformation:
      type: object
      properties:
        firstName:
          type: string
          description: Legal first name of the individual party; mandatory if
            partyType=INDIVIDUAL
          example: John
        middleName:
          type: string
          description: Legal middle name
          example: M
        lastName:
          type: string
          description: Legal last name; mandatory if partyType=INDIVIDUAL
          example: Doe
        suffix:
          type: string
          description: Name suffix
          example: SR
        prefix:
          type: string
          description: Name prefix/title
          example: MR
        dateOfBirth:
          type: string
          format: date
          description: Date of birth; mandatory if partyType=INDIVIDUAL
          example: 1990-01-01
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
            - UNKNOWN
          description: Gender of the individual party
          example: MALE
        birthSex:
          type: string
          enum:
            - MALE
            - FEMALE
            - UNKNOWN
          description: Birth sex, used for underwriting/rating
          example: MALE
        birthCountry:
          type: string
          description: Country of birth (ISO-3166 alpha-2)
          example: US
        citizenCountry:
          type: string
          description: Country of citizenship (ISO-3166 alpha-2)
          example: US
    PolicyCoverageChangesPartyIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - PASSPORT
            - SSN
            - DRIVERSLICENSE
            - NATIONALID
          description: Type of government or legal identification document
          example: PASSPORT
        value:
          type: string
          description: Value/number of the identifier
          example: "123456789"
        description:
          type: string
          description: Free-text description of the identifier
          example: Passport number
        source:
          type: string
          description: Issuing authority or source
          example: State of California
        issueDate:
          type: string
          format: date
          description: Date issued
          example: 2015-08-15
        expirationDate:
          type: string
          format: date
          description: Date of expiration
          example: 2025-08-15
        status:
          type: string
          enum:
            - ACTIVE
            - EXPIRED
            - INACTIVE
          description: Current status of the identifier
          example: ACTIVE
        countryOfIssue:
          type: string
          description: Country that issued the identifier (ISO-3166 alpha-2)
          example: US
    PolicyCoverageChangesAddress:
      type: object
      properties:
        addressType:
          type: string
          enum:
            - RESIDENCE
            - MAILING
            - BUSINESS
          description: Classification of the address
          example: RESIDENCE
        addressLine1:
          type: string
          description: Primary street address line
          example: 123 Main St
        addressLine2:
          type: string
          description: Secondary address line
          example: Apt 4B
        addressLine3:
          type: string
          description: Tertiary address line
          example: Apt 4B
        city:
          type: string
          description: City of the address
          example: San Francisco
        state:
          type: string
          description: State or province
          example: CA
        zipCode:
          type: string
          description: Postal/ZIP code
          example: "94105"
        zipCodeExt:
          type: string
          description: ZIP+4 extension
          example: "4465"
        country:
          type: string
          description: Country of the address (ISO-3166 alpha-2)
          example: US
      required:
        - addressLine1
        - city
        - state
        - country
    PolicyCoverageChangesPhoneNumber:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of this phone record
          example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
        type:
          type: string
          enum:
            - MOBILE
            - HOME
            - WORK
          description: Classification of the phone number
          example: MOBILE
        countryCode:
          type: string
          description: Country calling code
          example: "1"
        areaCode:
          type: string
          description: Area code
          example: "973"
        dialNumber:
          type: string
          description: Local dial number; mandatory if phone supplied
          example: "7657890"
        extension:
          type: string
          nullable: true
          description: Extension number, if applicable; send JSON null when not applicable
          example: null
        bestTime:
          type: string
          nullable: true
          description: Best time of day to reach the party
          example: null
        timezone:
          type: string
          nullable: true
          description: Timezone associated with the phone number
          example: null
      required:
        - dialNumber
    PolicyCoverageChangesEmail:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of this email record
          example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
        type:
          type: string
          enum:
            - PERSONAL
            - BUSINESS
          description: Classification of the email address
          example: PERSONAL
        address:
          type: string
          format: email
          description: The email address; mandatory if email supplied
          example: user@example.com
      required:
        - address
    PolicyCoverageChangesSignature:
      type: object
      properties:
        date:
          type: string
          format: date
          description: Date the signature was captured
          example: 2021-01-12
        city:
          type: string
          description: City where the signature was captured
          example: Quincy
        state:
          type: string
          description: State where the signature was captured
          example: CA
    PolicyCoverageChangesParty:
      type: object
      properties:
        partyId:
          type: string
          description: Unique identifier assigned to a party under this transaction;
            cross-referenced from policyUpdateRequest[].party and payment.party
          example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
        partyRole:
          $ref: "#/components/schemas/PolicyCoverageChangesPartyRole"
        partyType:
          type: string
          enum:
            - INDIVIDUAL
            - ENTITY
          description: Indicates whether the party is a natural person or a non-person
            entity
          example: INDIVIDUAL
        personalInformation:
          $ref: "#/components/schemas/PolicyCoverageChangesPersonalInformation"
        partyCommunication:
          type: string
          description: Preferred communication method for this party
          example: REGULARMAIL
        identifiers:
          type: array
          items:
            $ref: "#/components/schemas/PolicyCoverageChangesPartyIdentifier"
        address:
          type: object
          properties:
            preferredAddressId:
              type: string
              description: Pointer to the party's primary address within addresses
              example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
            addresses:
              type: array
              items:
                allOf:
                  - $ref: "#/components/schemas/PolicyCoverageChangesAddress"
                  - type: object
                    properties:
                      id:
                        type: string
                        description: Unique identifier of this address record
                        example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
        phoneNumber:
          type: object
          properties:
            preferredPhoneId:
              type: string
              description: Pointer to the party's primary phone within phoneNumbers
              example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
            phoneNumbers:
              type: array
              items:
                $ref: "#/components/schemas/PolicyCoverageChangesPhoneNumber"
        email:
          type: object
          properties:
            preferredEmailId:
              type: string
              description: Pointer to the party's primary email within emails
              example: 2ad51ecf-9923-437f-a6f0-70968e464cdb
            emails:
              type: array
              items:
                $ref: "#/components/schemas/PolicyCoverageChangesEmail"
        signatures:
          type: array
          items:
            $ref: "#/components/schemas/PolicyCoverageChangesSignature"
      required:
        - partyId
        - partyRole
        - partyType
```