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

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

# Payor

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    Url:
      type: object
      properties:
        website:
          type: string
          description: Carrier or Third party administrator website
          example: https://zinnialive.com/
        carrierLogin:
          type: string
          description: Carrier login
          example: https://zinnialive.com/
        agentLogin:
          type: string
          description: Agent login
          example: https://zinnialive.com/
        customerLogin:
          type: string
          description: Customer login
          example: https://wellabe.mypolicyview.com/
    FormerName:
      type: object
      properties:
        firstName:
          type: string
          description: Former first name of the party/trustee
          example: Karen
        middleName:
          type: string
          description: Former middle name of the party/trustee
          example: Anne
        lastName:
          type: string
          description: Former last name of the party/trustee
          example: Bates
        prefix:
          $ref: "#/components/schemas/Prefix"
        suffix:
          type: string
          enum:
            - JR
            - SN
            - SR
            - I
            - II
            - III
            - IV
            - V
            - VI
            - VII
          description: The suffix of the party name
        fullName:
          type: string
          description: Former full name of the party/Former legal name of the
            Trust/Organization
          example: Karen Anne Bates
        abbreviatedName:
          type: string
          description: The former shortened/abbreviated version of the organization`s name
            that is unique to the organization
          example: TBD
        doingBusinessAs:
          type: string
          description: The former name the organization is commonly known as
          example: TBD
    Identification:
      type: object
      properties:
        identificationId:
          type: string
          description: A unique system-generated ID for tracking individual identifier
            records
          example: "1"
        startDate:
          type: string
          description: The date from which the party`s identifier is considered valid.
            Date (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        endDate:
          type: string
          description: The date after which the party`s identifier is no longer valid.
            Date (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        identificationType:
          type: string
          enum:
            - PASSPORT
            - STATEPHOTOID
            - DRIVERLICENSENUMBER
            - SSN
            - TIN
            - EXTERNAL
            - EIN
            - NATIONALPRODUCERNUMBER
            - OTHER
          description: Specifies the kind of identifier provided for a party. It describes
            what type of document or number is being used to recognize or verify
            the party's identity
          nullable: true
        identificationKey:
          type: string
          example: 666-50-8548
          description: A unique code (such as ECN, Life Party ID, or Series Code) used to
            uniquely identify and manage individuals, entities, or product
            groupings within life insurance and annuity systems
        identificationValue:
          type: string
          example: 666-50-8548
          description: The unique number of the selected identification type
          nullable: true
        identificationDescription:
          type: string
          example: Employee Control Number
          description: A brief description of the identifier.
        issueState:
          type: string
          enum:
            - AA
            - AE
            - AL
            - AP
            - AK
            - AZ
            - AR
            - AS
            - CA
            - CO
            - CT
            - DC
            - DE
            - FL
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MA
            - MI
            - MN
            - MS
            - MO
            - MP
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - OH
            - OK
            - OR
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UM
            - UT
            - VT
            - VA
            - VI
            - WA
            - WV
            - WI
            - WY
          nullable: true
        issueCountry:
          type: string
          enum:
            - US
            - CA
            - RU
            - EG
            - ZA
            - GR
            - NL
            - BE
            - FR
            - ES
            - HU
            - IT
            - RO
            - CH
            - AT
            - GB
            - DK
            - SE
            - NO
            - PL
            - DE
            - PE
            - MX
            - CU
            - AR
            - BR
            - CL
            - CO
            - VE
            - MY
            - AU
            - ID
            - PH
            - NZ
            - SG
            - TH
            - JP
            - VN
            - CN
            - TR
            - IN
            - PK
            - AF
            - LK
            - IR
            - MA
            - DZ
            - TN
            - LY
            - GM
            - SN
            - MR
            - ML
            - GN
            - BF
            - NE
            - TG
            - BJ
            - MU
            - LR
            - SL
            - GH
            - NG
            - CF
            - TD
            - CM
            - CV
            - ST
            - GQ
            - GA
            - BS
            - AO
            - BB
            - AX
            - SD
            - RW
            - ET
            - SO
            - DJ
            - KE
            - TZ
            - UG
            - BI
            - MZ
            - ZM
            - MG
            - RE
            - ZW
            - NA
            - MW
            - LS
            - BW
            - AG
            - KM
            - GW
            - CD
            - VG
            - SH
            - AW
            - FO
            - GL
            - KY
            - GI
            - PT
            - LU
            - IE
            - IS
            - AL
            - MT
            - CY
            - FI
            - BG
            - GG
            - LT
            - LV
            - EE
            - MD
            - AM
            - BY
            - AD
            - SM
            - UA
            - HR
            - SI
            - BA
            - MK
            - XK
            - CZ
            - SK
            - LI
            - BM
            - GD
            - FK
            - BZ
            - GT
            - SV
            - HN
            - NI
            - CR
            - PM
            - HT
            - PR
            - VI
            - GS
            - SX
            - BQ
            - GP
            - BO
            - GY
            - EC
            - GF
            - PY
            - MQ
            - SR
            - UY
            - AN
            - TC
            - BL
            - MF
            - MS
            - GU
            - AQ
            - BN
            - NR
            - PG
            - TO
            - SB
            - VU
            - FJ
            - WF
            - CK
            - NU
            - AS
            - KI
            - NC
            - TV
            - PF
            - MP
            - PW
            - MH
            - FM
            - SS
            - LC
            - DM
            - VC
            - DO
            - HK
            - MO
            - KH
            - LA
            - TT
            - KN
            - JM
            - BD
            - TW
            - MM
            - KR
            - KP
            - LB
            - JO
            - SY
            - IQ
            - KW
            - SA
            - OM
            - AE
            - IL
            - BH
            - QA
            - BT
            - NP
            - TJ
            - TM
            - AZ
            - GE
            - UZ
            - AI
            - PA
            - CI
            - ER
            - KZ
            - KG
            - CC
            - MN
            - BV
            - SC
            - IO
            - WS
            - TL
            - TF
            - YT
            - PN
            - SJ
            - TK
            - UM
            - EH
            - MV
            - CX
            - NF
            - CG
            - MC
            - VA
            - SZ
            - PS
            - JE
            - IM
            - RS
            - ME
            - HM
            - CW
            - CS
            - YE
            - YD
            - SU
            - YU
            - ZR
          nullable: true
    Address:
      type: object
      properties:
        startDate:
          type: string
          description: The start date of the party address. Date (with pattern "yyyy-mm-dd")
          example: 2023-01-01
        endDate:
          type: string
          description: The end date of the party address. Date (with pattern "yyyy-mm-dd")
          example: 2023-01-01
        addressType:
          $ref: "#/components/schemas/AddressType"
        addressLine1:
          type: string
          description: Address Line 1 of the party address
          example: 1112 Pickle Street
        addressLine2:
          type: string
          description: Address Line 2 of the party address
          example: South Jersey
        addressLine3:
          type: string
          description: Address Line 3 of the party address
          example: 1234 Post box
        city:
          type: string
          description: City of the party address
          example: Garden City
        state:
          $ref: "#/components/schemas/State"
        zipCode:
          type: string
          description: Zip code of the party address
          example: "67846"
        zipCodeExtension:
          type: string
          description: Unit of the party address
          example: "23"
        country:
          $ref: "#/components/schemas/Country"
        isPreferred:
          type: boolean
          description: TBD
        addressId:
          type: string
          description: The record Id stored internally in zahara for each address
          example: "1"
        preferredAddress:
          type: boolean
          description: TBD
          example: false
    Phone:
      type: object
      properties:
        startDate:
          type: string
          description: The start date of when the party can be reached via the phone.Date
            (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        endDate:
          type: string
          description: The end date of when the party can be reached via the phone. Date
            (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        phoneType:
          $ref: "#/components/schemas/PhoneType"
        countryCode:
          type: string
          description: Country Code of the phone
          example: "9"
        areaCode:
          type: string
          description: Area code of the phone
          example: "973"
        dialNumber:
          type: string
          description: Dial number of the phone
          example: "765789"
        extension:
          type: string
          description: Dial in Extension for phone
          example: "null"
        bestTime:
          type: string
          description: The best time to contact the party via phone
          example: "null"
        timezone:
          type: string
          description: Timezone for the entered phone details
          example: "null"
        isPreferred:
          type: boolean
          description: The Preferred Phone Indicator is a boolean flag or attribute
            assigned to each phone number associated with a party, used to
            identify which phone number should be used as the primary contact
            number for communication
        phoneId:
          type: string
          description: The record Id stored internally in zahara for each phone
          example: "1"
    Email:
      type: object
      properties:
        startDate:
          type: string
          description: The start date of when the party can be reached via email.Date
            (with pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        endDate:
          type: string
          description: The end date of when the party can be reached via email. Date (with
            pattern "yyyy-mm-dd")
          example: 2023-01-01
          format: date
        emailType:
          $ref: "#/components/schemas/EmailType"
        emailAddress:
          type: string
          description: Email address of the party
          example: user@example.com
        isPreferred:
          type: boolean
          description: The Preferred Email Indicator is a boolean flag associated with
            each email address linked to a party, used to designate which email
            address should be treated as the primary contact for electronic
            communications
        emailId:
          type: string
          description: The record Id stored internally in zahara for each email
          example: "1"
    BankDetails:
      type: object
      properties:
        recordId:
          type: number
        appliesToPartyId:
          type: string
        financialInstitutionPartyId:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        nameOnAccount:
          type: string
        accountStatus:
          type: string
        accountType:
          type: string
        accountNumber:
          type: string
        routingNumber:
          type: string
        ibaNumber:
          type: string
        branchName:
          type: string
        accountPurpose:
          type: string
        branchAddress:
          $ref: "#/components/schemas/Address"
        branchPhoneNumber:
          type: string
      required:
        - recordId
        - appliesToPartyId
        - financialInstitutionPartyId
        - startDate
        - endDate
        - nameOnAccount
        - accountStatus
        - accountType
        - accountNumber
        - routingNumber
        - ibaNumber
        - branchName
        - accountPurpose
        - branchAddress
        - branchPhoneNumber
    RiskDetails:
      type: object
      properties:
        existingLifeInsurance:
          type: boolean
        existingLifeInsuranceAmount:
          type: number
        replaceLifeInsurance:
          type: boolean
        pendingOrPlanToBuyAdditional:
          type: boolean
        isDependent:
          type: boolean
        employed:
          type: boolean
        employmentStatus:
          type: string
        occupation:
          type: string
        householdIncome:
          type: number
      required:
        - existingLifeInsurance
        - existingLifeInsuranceAmount
        - replaceLifeInsurance
        - pendingOrPlanToBuyAdditional
        - isDependent
        - employed
        - employmentStatus
        - occupation
        - householdIncome
    Prefix:
      type: string
      enum:
        - MR
        - MS
        - MISS
        - MRS
        - DR
    AddressType:
      type: string
      enum:
        - RESIDENCE
        - BUSINESS
        - POBOX
        - SEASONAL
        - SECONDARY
        - MAILING
    State:
      type: string
      enum:
        - AA
        - AE
        - AL
        - AP
        - AK
        - AZ
        - AR
        - AS
        - CA
        - CO
        - CT
        - DC
        - DE
        - FL
        - GA
        - GU
        - HI
        - ID
        - IL
        - IN
        - IA
        - KS
        - KY
        - LA
        - ME
        - MD
        - MA
        - MI
        - MN
        - MS
        - MO
        - MP
        - MT
        - NE
        - NV
        - NH
        - NJ
        - NM
        - NY
        - NC
        - ND
        - OH
        - OK
        - OR
        - PA
        - PR
        - RI
        - SC
        - SD
        - TN
        - TX
        - UM
        - UT
        - VT
        - VA
        - VI
        - WA
        - WV
        - WI
        - WY
    Country:
      type: string
      enum:
        - US
        - CA
        - RU
        - EG
        - ZA
        - GR
        - NL
        - BE
        - FR
        - ES
        - HU
        - IT
        - RO
        - CH
        - AT
        - GB
        - DK
        - SE
        - NO
        - PL
        - DE
        - PE
        - MX
        - CU
        - AR
        - BR
        - CL
        - CO
        - VE
        - MY
        - AU
        - ID
        - PH
        - NZ
        - SG
        - TH
        - JP
        - VN
        - CN
        - TR
        - IN
        - PK
        - AF
        - LK
        - IR
        - MA
        - DZ
        - TN
        - LY
        - GM
        - SN
        - MR
        - ML
        - GN
        - BF
        - NE
        - TG
        - BJ
        - MU
        - LR
        - SL
        - GH
        - NG
        - CF
        - TD
        - CM
        - CV
        - ST
        - GQ
        - GA
        - BS
        - AO
        - BB
        - AX
        - SD
        - RW
        - ET
        - SO
        - DJ
        - KE
        - TZ
        - UG
        - BI
        - MZ
        - ZM
        - MG
        - RE
        - ZW
        - NA
        - MW
        - LS
        - BW
        - AG
        - KM
        - GW
        - CD
        - VG
        - SH
        - AW
        - FO
        - GL
        - KY
        - GI
        - PT
        - LU
        - IE
        - IS
        - AL
        - MT
        - CY
        - FI
        - BG
        - GG
        - LT
        - LV
        - EE
        - MD
        - AM
        - BY
        - AD
        - SM
        - UA
        - HR
        - SI
        - BA
        - MK
        - XK
        - CZ
        - SK
        - LI
        - BM
        - GD
        - FK
        - BZ
        - GT
        - SV
        - HN
        - NI
        - CR
        - PM
        - HT
        - PR
        - VI
        - GS
        - SX
        - BQ
        - GP
        - BO
        - GY
        - EC
        - GF
        - PY
        - MQ
        - SR
        - UY
        - AN
        - TC
        - BL
        - MF
        - MS
        - GU
        - AQ
        - BN
        - NR
        - PG
        - TO
        - SB
        - VU
        - FJ
        - WF
        - CK
        - NU
        - AS
        - KI
        - NC
        - TV
        - PF
        - MP
        - PW
        - MH
        - FM
        - SS
        - LC
        - DM
        - VC
        - DO
        - HK
        - MO
        - KH
        - LA
        - TT
        - KN
        - JM
        - BD
        - TW
        - MM
        - KR
        - KP
        - LB
        - JO
        - SY
        - IQ
        - KW
        - SA
        - OM
        - AE
        - IL
        - BH
        - QA
        - BT
        - NP
        - TJ
        - TM
        - AZ
        - GE
        - UZ
        - AI
        - PA
        - CI
        - ER
        - KZ
        - KG
        - CC
        - MN
        - BV
        - SC
        - IO
        - WS
        - TL
        - TF
        - YT
        - PN
        - SJ
        - TK
        - UM
        - EH
        - MV
        - CX
        - NF
        - CG
        - MC
        - VA
        - SZ
        - PS
        - JE
        - IM
        - RS
        - ME
        - HM
        - CW
        - CS
        - YE
        - YD
        - SU
        - YU
        - ZR
    PhoneType:
      type: string
      enum:
        - MOBILE
        - HOME
        - BUSINESS
        - CLAIMCENTER
        - CUSTOMERSERVICE
        - CORPORATEOFFICE
        - FAX
        - UNKNOWN
        - OTHER
    EmailType:
      type: string
      enum:
        - PERSONAL
        - BUSINESS
        - CUSTOMERSERVICE
        - OTHER
    Payor:
      type: object
      properties:
        id:
          type: string
        policyDetailsId:
          type: string
        ledgerDocId:
          type: string
        timestamp:
          format: date-time
          type: string
        policyNumber:
          type: string
        partyMasterId:
          type: string
        partyId:
          type: string
        idReferenceNo:
          type: string
        beneficiaryPercentage:
          type: number
        partyType:
          type: string
        url:
          $ref: "#/components/schemas/Url"
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        fullName:
          type: string
        prefix:
          type: string
        suffix:
          type: string
        gender:
          type: string
        dateOfBirth:
          type: string
        attainedAge:
          type: number
        birthCountry:
          type: string
        birthState:
          type: string
        dba:
          type: string
        abbrName:
          type: string
        orgCode:
          type: string
        entityType:
          type: string
        trustDate:
          type: string
        trustType:
          type: string
        prefCommunicationType:
          type: string
        formerName:
          $ref: "#/components/schemas/FormerName"
        identifications:
          type: array
          items:
            $ref: "#/components/schemas/Identification"
        addresses:
          type: array
          items:
            $ref: "#/components/schemas/Address"
        phones:
          type: array
          items:
            $ref: "#/components/schemas/Phone"
        emails:
          type: array
          items:
            $ref: "#/components/schemas/Email"
        bankDetails:
          type: array
          items:
            $ref: "#/components/schemas/BankDetails"
        dateOfDeath:
          type: string
        stateOfDeath:
          type: string
        disabled:
          type: boolean
        disabilityStartDate:
          type: string
        riskDetails:
          $ref: "#/components/schemas/RiskDetails"
        financialInstitutionPartyId:
          type: string
        percentage:
          type: number
        version:
          type: number
      required:
        - id
        - policyDetailsId
        - ledgerDocId
        - timestamp
        - policyNumber
        - partyMasterId
        - partyId
        - idReferenceNo
        - beneficiaryPercentage
        - partyType
        - url
        - firstName
        - middleName
        - lastName
        - fullName
        - prefix
        - suffix
        - gender
        - dateOfBirth
        - attainedAge
        - birthCountry
        - birthState
        - dba
        - abbrName
        - orgCode
        - entityType
        - trustDate
        - trustType
        - prefCommunicationType
        - formerName
        - identifications
        - addresses
        - phones
        - emails
        - bankDetails
        - dateOfDeath
        - stateOfDeath
        - disabled
        - disabilityStartDate
        - riskDetails
        - financialInstitutionPartyId
        - percentage
        - version
```