--- title: "Get Policy Parties" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/operations/Parties" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # Get Policy Parties `GET` `/policy/v1/policies/{planCode}/{policyNumber}/parties` Operation ID: `Parties` ## Path parameters - `planCode` (string, required) - `policyNumber` (string, required) ## Query parameters - `partyRole` (string, optional) - `partyId` (string, optional) ## Responses - `200` - OK - `400` - Bad Request - `404` - Not Found - `500` - Unexpected error occured, please check server logs ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://qa.api.zinnia.io paths: /policy/v1/policies/{planCode}/{policyNumber}/parties: get: operationId: Parties summary: Get Policy Parties parameters: - name: partyRole required: false in: query schema: enum: - Owner - JointOwner - Annuitant - JointAnnuitant - Payee - Payor - ThirdPartyDesignee - PrimaryBeneficiary - ContingentBeneficiary - Grantor - Trustee - PowerOfAttorney type: string - name: partyId required: false in: query schema: type: string - name: planCode required: true in: path schema: type: string - name: policyNumber required: true in: path schema: type: string responses: "200": description: OK content: application/json: schema: type: array items: $ref: "#/components/schemas/PolicyPartyResponse" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "500": description: Unexpected error occured, please check server logs security: - Auth0: [] tags: - Details security: - Auth0: [] components: schemas: PolicyPartyResponse: type: object properties: partyType: $ref: "#/components/schemas/PartyType" partyRoleId: type: string description: TBD parentPartyId: type: string description: "The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)" example: "1" beneficiaryPercentage: type: number description: Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary example: 100 format: double agentPercentage: type: number format: double description: Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent example: 100 agentExternalId: type: string description: The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent example: "3160000751" agentType: $ref: "#/components/schemas/AgentType" firstName: type: string description: The first name of the party/trustee example: Karen middleName: type: string description: The middle name of the party/trustee example: Anne lastName: type: string description: The last name of the party/trustee example: Bates fullName: type: string description: The full name of the party/The legal name of the Trust/Organization example: Karen Anne 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 gender: $ref: "#/components/schemas/Gender" dateOfBirth: type: string description: The date of birth of the party format: date example: 2023-01-01 genderIdentity: type: string description: Gender Identity refers to an individual's self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy example: TBD attainedAge: type: integer description: Age calculated by date of birth and Policy year format: int32 example: 55 birthCountry: $ref: "#/components/schemas/Country" citizenCountry: $ref: "#/components/schemas/Country" birthState: $ref: "#/components/schemas/State" doingBusinessAs: type: string description: The name the organization is commonly known as example: TBD abbreviatedName: type: string description: The shortened/abbreviated version of the organization`s name that is unique to the organization example: TBD organizationCode: type: string description: Code to Identify organization example: TBD entityType: $ref: "#/components/schemas/EntityType" trustDate: type: string description: The trust agreement issued date to the party format: date example: 2023-01-01 amendedTrustDate: type: string description: The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy format: date example: 2023-01-01 governingStateOfTrust: $ref: "#/components/schemas/State" trustType: $ref: "#/components/schemas/TrustType" trustTitle: type: string description: The title of the trustee example: TBD trustAccessCode: type: string description: Access code of the trustee example: TBD preferredCommunicationType: $ref: "#/components/schemas/PreferredCommunicationType" preferredAddressIndicator: type: string description: Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section example: "1" preferredAddressId: type: string description: The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping example: "1" preferredEmailId: type: string description: The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file example: "1" preferredPhoneId: type: string description: The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party example: "1" partyPercentage: type: number format: double description: Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties example: 12.1213 deprecated: true formerName: $ref: "#/components/schemas/FormerName" identifications: type: array items: $ref: "#/components/schemas/Identification" taxWithholdings: type: array items: $ref: "#/components/schemas/TaxWithholding" partyStatus: $ref: "#/components/schemas/PartyStatus" isPartyBeneficiaryNonNatural: type: boolean description: A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities isIrrevocable: type: boolean description: An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms isRequiredMinimumDistributionDesignated: type: boolean description: An indicator if the beneficiary is designated to be included in Joint RMD calculations lastContactDate: type: string format: date description: Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products. example: 2023-01-01 beneficiaryShareMethod: type: string enum: - PERSTIRPESDISTRIBUTION description: The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request. delegatedExecutionAuthorityType: $ref: "#/components/schemas/DelegatedExecutionAuthorityType" partyRoles: type: array items: $ref: "#/components/schemas/PolicyPartyRoles" partyId: type: string description: Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions example: Party_PB_Primary_Bene_1 addresses: description: Array of addresses associated with the party type: array items: $ref: "#/components/schemas/Address" phones: description: Array of phone numbers associated with the party type: array items: $ref: "#/components/schemas/Phone" emails: description: Array of emails associated with the party type: array items: $ref: "#/components/schemas/Email" bankDetails: description: Array of bank accounts associated with the party type: array items: $ref: "#/components/schemas/BankAccount" deathDetails: $ref: "#/components/schemas/DeathDetail" impairmentDetails: $ref: "#/components/schemas/ImpairmentDetails" timestamp: type: string description: TBD example: 2023-01-01T12:00:00.000Z format: date-time policyNumber: type: string description: Policy number example: POLICY1234567890 customerId: type: string description: TBD example: 0017b000010N4bCAAS insured: $ref: "#/components/schemas/Insured" version: type: number example: 1 format: int32 required: - timestamp - policyNumber - customerId - insured - version ErrorResponse: type: object properties: timestamp: type: string format: date-time example: 2023-01-01T12:00:00.000Z message: type: string PartyType: type: string enum: - INDIVIDUAL - ORGANIZATION - TRUST - INSURED AgentType: type: string enum: - ACCOUNTMANAGER - ADDITIONALCOMPENSATIONRECIPIENT - ADVANCEDUNDERWRITINGCONSULTANT - AGENCYORGENERALAGENT - AGENCYDIRECTOR - AGENCYSUPERINTENDENT - AGENCYVICEPRESIDENT - AGENTORPRODUCER - ASSISTANT - ASSISTANTGROUPUNDERWRITER - ASSISTANTMANAGER - ASSISTANTVICEPRESIDENT - ASSISTANTVPCOMPLIANCE - ASSOCIATEAGENCYMANAGER - ASSOCIATEFINANCIALPLANNER - ASSOCIATEOFFICERMANAGER - ASSOCIATESALEDEVELOPMENTMANAGERINTRAINING - ASSOCIATESALESDEVELOPMENTMANAGER - BANK - BANKEMPLOYEE - BRANCHMANAGER - BROKER - BROKERORDEALER - BROKERAGEDIRECTOR - BROKERAGEGENERALAGENT - CERTIFIEDFINANCIALPLANNER - DISTRIBUTOR - FINANCIALCONSULTANT - FINANCIALPLANNER - MANAGINGDIRECTOR - MANAGINGGENERALAGENT - OFFICEMANAGER - OTHER - PLATFORMREP - QUALIFYINGOFFICER - REGISTEREDFINANCIALPLANNER - REGISTEREDREPRESENTATIVE - SALESDEVELOPMENTMANAGER - SECONDLINEMANAGER - SENIORADMINISTRATIVECONSULTANT - SENIORADVANCEDUNDERWRITINGCONSULTANT - SENIORFINANCIALPLANNER - SENIORGROUPACCOUNTEXECUTIVE - SENIORGROUPSALESREPRESENTATIVE - SENIORPARTNER - SENIORSALESDEVELOPMENTMANAGER - SENIORVICEPRESIDENT - SERVICINGBROKER - SERVICINGONLYAGENT - SOLICITOR - TEAM - UNKNOWN Prefix: type: string enum: - MR - MS - MISS - MRS - DR Gender: type: string enum: - MALE - FEMALE - UNISEX 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 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 EntityType: type: string enum: - SOLEPROPRIETORSHIP - GENERALPARTNERSHIP - LIMITEDPARTNERSHIP - CCORPORATION - SCORPORATION - LIMITEDLIABILITYCOMPANY - CHARITABLEORGANIZATION - ESTATE - TRUST - CORPORATION - UNKNOWN TrustType: type: string enum: - INDIVIDUALTRUST - CORPORATETRUST - TESTAMENTARYTRUST - INTERVIVOSTRUST - GRANTORTRUST - PETTRUST PreferredCommunicationType: type: string enum: - EMAIL - REGULARMAIL - PHONE - FAX - TEXT - NOPREFERENCESPECIFIED - POSTAL - OTHER 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 TaxWithholding: type: object properties: appliesToPartyId: type: string description: Party ID at Policy Level that comes in from External source (for Everly it will be Acord 103). This ties to the Party Type this tax withholding corresponds to. example: Party_PI_1 taxWithholdingType: $ref: "#/components/schemas/TaxWithholdingType" effectiveDate: type: string format: date example: 2024-01-01 description: Date on which the tax withholding instruction becomes effective for the party. endDate: type: string format: date example: 2024-12-31 description: Date on which the tax withholding instruction is no longer applicable for the party. taxRateToUse: $ref: "#/components/schemas/TaxRateToUse" filingStatus: $ref: "#/components/schemas/FilingStatus" dollar: type: number description: The dollar amount of tax withheld format: double example: 0 percentage: type: number description: The percentage amount of tax withheld format: double example: 0 exemptions: type: number description: The total exemptions claimed for tax purposes format: int32 example: 0 taxJurisdiction: type: string description: This is not input field i.e. user does not select or set this value. For Tax Withholding Type = State , DAML will set this value using PartyLevelAddressCountry_PartyLevelAddressState referring to ACCORD standard. For Tax Withholding Type = Federal , DAML will set this value using PartylevelAddressCountry using ACCORD standard.For FedeFor MVP, NRA jurisdictions are out of scope example: USA_WY contribution: $ref: "#/components/schemas/Contribution" taxFormType: $ref: "#/components/schemas/TaxFormType" w4p: $ref: "#/components/schemas/W4P" PartyStatus: type: string enum: - APPROVED - NOTAPPROVED - PROCESSED DelegatedExecutionAuthorityType: type: string enum: - INDEPENDENT - TOGETHER - MAJORITY PolicyPartyRoles: type: object properties: partyRoleId: type: string example: "8" format: int32 description: The Party Role ID is a unique identifier assigned to a specific role that a party (individual or entity) plays within an insurance or annuity contract. It serves to distinctly track and manage the relationship between the party and the contract, especially when a party may have multiple roles across different policies or within the same policy partyRole: $ref: "#/components/schemas/PartyRole" partyId: type: string example: Party_PI_1 description: Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions relationshipToInsured: type: string enum: - TRUSTEE - TRUSTEEOFMINOR - TRUSTEEOFINCOMPETENT - POWEROFATTORNEY - CONTROLLINGPERSONOFENTITY - BROTHER - CHILD - DAUGHTER - DOMESTICPARTNER - EXECUTORS - FATHER - FIANCE - GRANDCHILD - LIFEPARTNER - MOTHER - SISTER - SON - SPOUSE - STEPFATHER - STEPMOTHER - SELF - LEGALGUARDIAN - BUSINESS - BUSINESSASSOCIATE - PARTNER - EMPLOYER - FORMERSPOUSE - GRANDPARENT - PARENT - OWNER - SIBLING - STEPCHILD - STEPARENT - OTHER - AUNT - GRANDFATHER - GRANDMOTHER - HUSBAND - WIFE - UNCLE - NIECE - NEPHEW - ESTATE - TRUST - GRANDSON - GRANDDAUGHTER - NONSPOUSE - CHILDRENEQUALLY - CHILDRENPERSTIRPES - PERSTIRPES - SURVIVINGSPOUS - COMORTGAGER - DEPENDENT description: The type of relationship to the party relationshipToParty: type: string enum: - TRUSTEE - TRUSTEEOFMINOR - TRUSTEEOFINCOMPETENT - POWEROFATTORNEY - CONTROLLINGPERSONOFENTITY - BROTHER - CHILD - DAUGHTER - DOMESTICPARTNER - EXECUTORS - FATHER - FIANCE - GRANDCHILD - LIFEPARTNER - MOTHER - SISTER - SON - SPOUSE - STEPFATHER - STEPMOTHER - SELF - LEGALGUARDIAN - BUSINESS - BUSINESSASSOCIATE - PARTNER - EMPLOYER - FORMERSPOUSE - GRANDPARENT - PARENT - OWNER - SIBLING - STEPCHILD - STEPARENT - OTHER - AUNT - GRANDFATHER - GRANDMOTHER - HUSBAND - WIFE - UNCLE - NIECE - NEPHEW - ESTATE - TRUST - GRANDSON - GRANDDAUGHTER - NONSPOUSE - CHILDRENEQUALLY - CHILDRENPERSTIRPES - PERSTIRPES - SURVIVINGSPOUS - COMORTGAGER - DEPENDENT description: The type of relationship to the party startDate: type: string format: date example: 2023-01-01 description: Date the Party was added to the Policy endDate: type: string format: date example: 2023-01-01 description: Date the Party was Terminated from the Policy preferredCommunicationType: $ref: "#/components/schemas/CommunicationType" preferredAddressId: type: string example: "1" description: Deprecated - kept for backward compatibility. Use preferredAddressId under party section. The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping preferredEmailId: type: string example: "1" description: Deprecated - kept for backward compatibility. Use preferredEmailId under party section. The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file preferredPhoneId: type: string example: "1" description: Deprecated - kept for backward compatibility. Use preferredPhoneId under party section. The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party isAddressSameAsOwner: type: boolean description: Boolean 0 = No 1 = Yes to denote if the email is the preferred lastContactDate: type: string example: 2023-01-01 description: Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products. format: date beneficiaryShareMethod: type: string enum: - PERSTIRPESDISTRIBUTION description: Roles that are essential in structuring life insurance and annuity contracts to meet the financial goals of policyholders and beneficiaries. collateralAmount: type: number format: double description: The Collateral Amount of an Assignee refers to the portion of a life insurance policy's value or benefit that is pledged as collateral to a third party (the assignee) under a collateral assignment agreement. This is commonly used when a policyholder uses a life insurance policy as security for a loan or other financial obligation. example: 1023.21 powerOfAttorneyAccessLevelType: $ref: "#/components/schemas/PowerOfAttorneyAccessLevelType" partyPercentage: type: number format: double description: Party Role Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties. example: 1023.21 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" BankAccount: type: object properties: startDate: type: string description: Date the Bank Account of the Party was added to the Policy. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: Date the Bank Account of the Party was terminated from the Policy. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date nameOnAccount: type: string description: Name of the Party on Bank Account example: abcdqwe accountStatus: $ref: "#/components/schemas/AccountStatus" accountType: $ref: "#/components/schemas/AccountType" bankAccountPurpose: $ref: "#/components/schemas/BankAccountPurpose" accountNumber: type: string description: The 7+ digit checking or savings account number example: "34567777745678" routingNumber: type: string description: The 9-digit routing transit number for the bank account/branch example: "123456789" internationalBankAccountNumber: type: string description: The bank account number for an international bank account (this field does not have check-digit validation) example: ibanNumber_66 branchName: type: string description: The name of the bank (such as Chase Manhattan) example: branch_66 branchPhoneNumber: type: string description: Phone Number of the Bank Branch example: "7766667777" branchAddress: $ref: "#/components/schemas/BranchAddress" bankId: type: string description: In the context of ACORD standards (the global data standards body for insurance), Bank ID refers to a unique identifier used to specify a financial institution involved in a disbursement, premium collection, or electronic funds transfer (EFT). It is critical for ensuring correct routing of payments or deposits between insurers, policyholders, beneficiaries, and third parties example: "1" appliesToPartyId: type: string example: Party_PI_1 description: This unique id ties to the Party Role that the bank details correspondes to. DeathDetail: type: object properties: dateOfDeath: type: string format: date description: The date on which the insured/annuitant died example: 2023-01-01 causeOfDeath: $ref: "#/components/schemas/CauseOfDeath" deathNotificationDate: type: string format: date description: The date on which carrier was notified of the death example: 2023-01-01 dateOfDueProof: type: string format: date description: Date the appropriate death paperwork was received (example - death certificate receive date) example: 2023-01-01 ImpairmentDetails: type: object properties: disabled: type: boolean description: Any disability details of the insured disabilityStartDate: type: string format: date description: The disability start date of the insured example: 2023-01-01 Insured: type: object properties: existingLifeInsurance: type: boolean description: Any existing life insurance details of the insured existingLifeInsuranceAmount: type: number format: double example: 0 description: The existing life insurance amount of the insured replaceLifeInsurance: type: boolean description: Any life insurance replacement details of the insured pendingOrPlanToBuyAdditional: type: boolean description: Any details of pending or plan to buy additional life insurance of the insured isDependent: type: boolean description: Any dependent details of the insured employed: type: boolean description: Any employment details of the insured employmentStatus: $ref: "#/components/schemas/EmploymentStatus" occupation: type: string description: Occupation of the insured example: Salesman householdIncome: type: number format: double description: Household income of the insured example: 50000 deathDetails: $ref: "#/components/schemas/DeathDetail" impairmentDetails: $ref: "#/components/schemas/ImpairmentDetails" TaxWithholdingType: type: string enum: - FEDERAL - STATE - NRA - BACKUP TaxRateToUse: type: string enum: - NOWITHHOLDINGELECTED - USEVALUESENTERED - NOWITHHOLDINGALLOWED - USEDEFAULTTABLE - ADDITIONALWITHHOLDING - TAKEINPUTTEDVALUE FilingStatus: type: string enum: - SINGLE - DOMESTICPARTNERSHIP - DEFAULT - MARRIED - HEADOFHOUSEHOLD - WIDOWED - DIVORCED - MARRIEDFILINGSEPARATELY Contribution: type: string enum: - NOTAPPLICABLE - EMPLOYEEVOLUNTARY - EMPLOYEEDISCRETIONARY TaxFormType: type: string enum: - T1035COSTBASIS - T1035LOANTRANSFER - T1035SURRENDER - T1035TAXADVANTAGE - T1099R - TAXDISCLOSUREFORMW4P - TAXDISCLOSUREFORMW8 - USW4TAXFORM - W9 - VOIDCHECK W4P: type: object properties: totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities: type: number format: double example: 12.12 description: "Below Amounts are for periodic Payments Only - Certain States Require these amounts to be entered " totalAmountOfClaimsAndOtherCredits: type: number format: double example: 213.73 description: "This indicates the total amount of tax claims and credits party is eligible for to reduce the tax liabilities " otherIncome: type: number format: double example: 144.53 description: "Not from Jobs or Pension/Annuities " otherDeduction: type: number format: double example: 42.83 description: If Standard Deduction is not used PartyRole: type: string enum: - OWNER - PRIMARYBENEFICIARY - CONTINGENTBENEFICIARY - INSURED - PAYOR - PAYEE - AGENT - PRIMARYWRITINGAGENT - PRIMARYSERVICINGAGENT - ADDITIONALSERVICINGAGENT - ADDITIONALWRITINGAGENT - THIRDPARTYDESIGNEE - JOINTOWNER - COVERAGEINSURED - ASSIGNEE - ANNUITANT - EXCHANGECOMPANY - JOINTANNUITANT - GRANTOR - TRUSTEE - POWEROFATTORNEY - AUTHORIZEDSIGNATORY - OTHERINTERESTEDPARTY - CONTINGENTOWNER - THIRDPARTYADMINISTRATOR - CARRIER - SUCCESSORTRUSTEE - COVERAGEJOINTINSURED CommunicationType: type: string enum: - EMAIL - REGULARMAIL - PHONE - FAX - TEXT - NOPREFERENCESPECIFIED - POSTAL - OTHER PowerOfAttorneyAccessLevelType: type: string enum: - FULLACCESS - LIMITEDACCESSFINANCIAL - LIMITEDACCESSNONFINANCIAL AddressType: type: string enum: - RESIDENCE - BUSINESS - POBOX - SEASONAL - SECONDARY - MAILING PhoneType: type: string enum: - MOBILE - HOME - BUSINESS - CLAIMCENTER - CUSTOMERSERVICE - CORPORATEOFFICE - FAX - UNKNOWN - OTHER EmailType: type: string enum: - PERSONAL - BUSINESS - CUSTOMERSERVICE - OTHER AccountStatus: type: string enum: - ACTIVEBANKACCOUNT - TERMINATEDBANKACCOUNT AccountType: type: string enum: - CHECKING - SAVINGS - CREDITCARD - DEBITCARD - BROKERAGEACCOUNT - CERTIFICATEOFDEPOSIT - WIRE BankAccountPurpose: type: string enum: - LOANINTERESTBILLING - DISBURSEMENTS - LOANPRINCIPALBILLING - PREMIUMBILLING - ONETIMEPREMIUMBILLING - PAYOUT - ONETIMEWIRE BranchAddress: type: object properties: addressType: $ref: "#/components/schemas/AddressType" addressLine1: type: string example: 1112 Pickle Street description: Address line 1 of the Bank addressLine2: type: string example: South Jersey description: Address line 2 of the Bank addressLine3: type: string example: 1234 Post box description: Address Line 3 of the bank city: type: string example: Garden City description: City of the bank address state: $ref: "#/components/schemas/State" zipCode: type: string example: "67846" description: Zip code of the bank address zipCodeExtension: type: string example: "23" description: Unit of the bank address country: $ref: "#/components/schemas/Country" CauseOfDeath: type: string enum: - AIDS - ACCIDENTOTHER - ACCIDENTBYFIRE - ACCIDENTALDROWNING - ACCIDENTALFALL - ACCIDENTALPOISONING - AIRCRAFTACCIDENT - ALCOHOLISM - ALLERGICDISORDERS - ANEMIA - APPENDICITIS - ARTERIALDISEASE - AVITAMINOSIS - BENIGNTUMOR - BIRTHINJURY - BRONCHITIS - BRONCHOPNEUMONIA - COVID - CANCERBONE - CANCERBREAST - CANCERCERVIX - CANCERESOPHAGUS - CANCERINTESTINE - CANCERLARYNX - CANCERLUNG - CANCERMOUTH - CANCEROTHER - CANCERPROSTATE - CANCERRECTUM - CANCERSKIN - CANCERSTOMACH - CANCERUTERUS - CIRCULATORYOTHER - CIRRHOSIS - CONGENITALDISORDER - DIABETES - DIGESTIVEDISEASEOTHER - DIPTHERIA - DRUGOVERDOSE - DYSENTERY - EARINFECTION - EMPHYSEMA - ENCEPHALITIS - ENLARGEDPROSTATE - EPILEPSY - FIREARMACCIDENT - FLU - GALLSTONE - GASTRITIS - GASTROENTERITIS - GOITERNONTOXIC - HEARTARTERIOSCLEROTIC - HEARTOTHER - HEARTRHEUMATIC - HERNIA - HOMICIDE - HYPERTENSIONHEART - HYPERTENSIONNOHEART - KIDNEYINFECTION - KIDNEYSTONE - LEUKAEMIA - LUNGDISEASEOTHER - LYMPHORSARCOMA - MACHINERYACCIDENT - MALARIA - MEASLES - MENINGITISMENIN - MENINGITISNONMENIN - MENTALDISORDER - MOTORVEHICLEACCIDENT - MULTIPLESCLEROSIS - NATURALDEATH - NEPHRITIS - NERVOUSSYSTEMOTHER - NEWBORNDISORDEROTHER - NEWBORNINFECTION - OSTEOMYELITIS - PARASITICDISEASEOTHER - PLEURISY - PNEUMONIALOBAR - PNEUMONIAOTHER - POLIO - PREGNANCYDISORDER - RHEUMATICFEVER - SCARLETFEVER - SENILITY - SEPTICAEMIA - SKINDISEASEOTHER - SKININFECTION - SUICIDE - SYPHILIS - TETANUS - THYROTOXICOSIS - TUBERCULOSIS - TYPHOID - TYPHUS - ULCEROFDUODENUM - ULCEROFSTOMACH - UNKNOWN - URINARYDISEASEOTHER - VASCULARLESIONS - WAR - WHOOPINGCOUGH - PENDINGINVESTIGATION - ACCIDENT EmploymentStatus: type: string enum: - ACTIVE - RETIRED - DISABLED - LAIDOFF - LEAVEDUETOCHILDBIRTH - LEAVEDUETOMILITARYSERVICE - LEAVEOFABSENCE - RESIGNED - SHORTTERMDISABILITY - TERMINATED - UNKNOWN - OTHER securitySchemes: Auth0: type: openIdConnect openIdConnectUrl: https://login.qa.zinnia.com/.well-known/openid-configuration x-kong-security-openid-connect: config: issuer: https://login.qa.zinnia.com/.well-known/openid-configuration extra_jwks_uris: - https://login.qa.mypolicyview.com/.well-known/jwks.json issuers_allowed: - https://login.qa.zinnia.com/ - https://login.qa.mypolicyview.com/ run_on_preflight: true scopes_claim: - https://qa.api.zinnia.io/permissions audience_claim: - aud audience_required: - https://qa.api.zinnia.io auth_methods: - bearer scopes: [] enabled: true protocols: - grpc - grpcs - http - https ```