---
title: "IriPartyPhone"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/IriPartyPhone"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# IriPartyPhone

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    IriPhoneType:
      type: string
      description: Classification of the phone number.
      enum:
        - MOBILE
        - HOME
        - BUSINESS
        - CLAIMCENTER
        - CUSTOMERSERVICE
        - CORPORATEOFFICE
        - FAX
        - UNKNOWN
        - OTHER
    IriPhoneBestTime:
      type: string
      description: Best time to contact the party via phone.
      enum:
        - MORNING
        - AFTERNOON
        - EVENING
        - ANYTIME
    IriPartyPhone:
      type: object
      properties:
        startDate:
          type: string
          description: Date the phone record becomes effective.
          example: 2026-03-06
          format: date
        endDate:
          type: string
          description: Date the phone record ends.
          example: 2027-03-06
          format: date
        phoneType:
          $ref: "#/components/schemas/IriPhoneType"
        countryCode:
          type: string
          description: Country code of the phone.
          example: "+1"
          pattern: ^\+?[0-9]{1,3}$
        areaCode:
          type: string
          description: Area code of the phone.
          example: "704"
          pattern: ^[0-9]{2,5}$
        dialNumber:
          type: string
          description: Dial number of the phone.
          example: "5550123"
          pattern: ^[0-9]{4,12}$
        extension:
          type: string
          description: Dial-in extension for the phone.
          example: "123"
          pattern: ^[A-Za-z0-9-]{1,10}$
        bestTime:
          $ref: "#/components/schemas/IriPhoneBestTime"
        timezone:
          type: string
          description: Timezone for the entered phone details.
          example: America/New_York
          pattern: ^[A-Za-z_]+/[A-Za-z_]+(?:/[A-Za-z_]+)?$
        isPreferred:
          type: boolean
          description: Whether this is the preferred phone number.
          example: true
        phoneId:
          type: string
          description: Record identifier for the phone.
          example: PH001
          pattern: ^[A-Za-z0-9._-]{1,100}$
      required:
        - countryCode
        - areaCode
        - dialNumber
```
