--- title: "PolicySummary" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/PolicySummary" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # PolicySummary ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://qa.api.zinnia.io components: schemas: Product: type: object properties: lineOfBusiness: type: string enum: - LIFE - ANNUITY - MUTUALFUND - CERTIFICATEOFDEPOSIT - BROKERAGE - OTHER description: Insurance and annuities are two distinct product lines of business (LOB) in the financial and insurance industry. Each serves different financial protection and income planning purposes planName: type: string description: The Product Name refers to the specific life insurance or annuity product selected by the contract owner at the time of policy issuance. It identifies the type of coverage, policy structure, and key features associated with the contract example: Everglades Premium Match productType: $ref: "#/components/schemas/ProductType" marketingName: type: string description: The Product Marketing Name refers to the branded name assigned by an insurance company to a specific life insurance or annuity product for marketing and sales purposes. It distinguishes products within an insurer`s portfolio and highlights key features and benefits for consumers example: Everglades shortName: type: string description: The Product Short Name is a condensed version of the full Product Marketing Name, typically used for internal systems, policy documents, billing, and reporting. It provides a simplified reference while still identifying the product accurately example: EVGL UL distribution: $ref: "#/components/schemas/DistributionType" planCode: type: string description: The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration example: PLAN001 generalLedgerPlanCode: type: string description: The GL Plan Code (General Ledger Plan Code) is a carrier-assigned accounting code used to track insurance products and financial transactions within an insurer’s general ledger system. It is essential for financial reporting, revenue allocation, and regulatory compliance example: V2201 holdingForm: $ref: "#/components/schemas/HoldingForm" renewable: type: string description: Renewable refers to a policy feature that allows the insured to extend coverage beyond the original term without requiring medical underwriting or a new application. This is commonly found in Term Life Insurance policies productVersion: type: string description: The Product Version refers to the specific edition or iteration of an insurance or annuity product, defined by its release date or modifications over time. It helps insurers and policyholders distinguish between different updates, pricing structures, regulatory changes, and feature enhancements within the same product line example: 2021.10.15 sourceSystemPlanCode: type: string description: The Source System Plan Code is the identifier assigned to a coverage from the source carrier. example: CARRIER01 PolicyStatus: type: string enum: - PENDINGISSUED - NOTISSUED - CANCELEDNOPREMIUM - ACTIVE - CANCELEDFREELOOK - PENDINGLAPSE - LAPSE - TERMINATED - MATURED - SURRENDERED - LIVINGCLAIMPENDING - DEATHCLAIMPENDING - DEATHCLAIMPAID - NOTTAKEN - ISSUED - PARTIALDEATHCLAIM - PAYOUT RestrictStatus: type: string enum: - LEGAL - OPERATIONAL - COMPLIANCE - MECRESTRICT - OVERPAYMENT - COLLATERALLYASSIGNEDUNSPECIFIED - DIVORCE 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 PolicyDates: type: object properties: policyStartDate: type: string format: date description: The Policy Start Date refers to the official date on which the policy becomes effective and coverage begins. This date is critical for determining premium payments, coverage eligibility, policy anniversaries, and contractual obligations example: 2023-01-01 applicationDate: type: string format: date description: The Application Date, also referred to as the Policy Sign Date, is the date when the policyholder completes and signs the insurance or annuity application. This marks the official request for coverage but does not necessarily mean the policy is active yet example: 2023-01-01 applicationReceivedDate: type: string format: date description: The Application Received Date refers to the date when Zinnia (or the designated insurance company/administrator) officially receives the completed insurance or annuity application example: 2023-01-01 issueDate: type: string format: date description: The Policy Issue Date, also known as the Policy Launch Date, is the date when the insurance company officially issues the policy to the client. This occurs after the application is approved, the insured accepts the offer, and payment information is provided. It marks the formal activation of the policy and triggers policy delivery example: 2023-01-01 parameterLockDate: type: string format: date description: The effective date used as applicable version of rate-locked parameters for this contract. example: 2023-01-01 applicationInGoodOrderDate: type: string format: date description: The Application IGO Date (In Good Order Date) refers to the date when the submitted application is deemed complete and accurate by Zinnia or the insurer, meaning it is ready for underwriting and processing but does not yet include the initial premium payment example: 2023-01-01 contestabilityStartDate: type: string format: date description: The Contestability Start Date refers to the beginning of the contestability period, which is the time frame in which an insurance company can investigate and deny a claim if material misrepresentations or fraud are found in the application example: 2023-01-01 contestabilityEndDate: type: string format: date description: The Contestability End Date is the date when the contestability period expires, meaning the insurer can no longer deny a claim based on misrepresentation or omission in the application, unless fraud is proven example: 2023-01-01 policyDeliveryDate: type: string format: date description: The Policy Delivery Date refers to the date when the policyholder is officially notified that their policy is available, either through an online portal, email, SMS, or physical mail. This date is critical because it marks the start of the free look period, allowing the policyholder to review the contract and cancel if needed example: 2023-01-01 previousPolicyAnniversaryDate: type: string format: date description: The Previous Policy Anniversary Date refers to the most recent past annual recurrence of the Policy Start Date. This date is used for tracking past premium payments, benefit updates, policy renewals, and cash value calculations example: 2023-01-01 previousPolicyMonthiversaryDate: type: string format: date description: The Previous Policy Monthiversary Date refers to the most recent past monthly recurrence of the Policy Start Date. It is used for tracking monthly premium payments, cost of insurance (COI) deductions, cash value updates, and policy charges example: 2023-01-01 nextAnniversaryDate: type: string format: date description: The Next Policy Anniversary Date refers to the upcoming annual recurrence of the policy’s start date. It is based on the Policy Start Date and marks key policy milestones such as premium due dates, cash value updates, policy renewals, and benefit adjustments example: 2023-01-01 maturityDate: type: string format: date description: The Policy Maturity Date refers to the date when a life insurance policy reaches its maturity or an annuity contract reaches its maximum annuitization age. It is based on the Policy Start Date and determines when benefits become payable or coverage ends example: 2023-01-01 policyTerminationDate: type: string format: date description: The Policy Termination Date is the date when a life insurance or annuity policy officially ends, meaning coverage ceases, and no further benefits or obligations exist under the contract. The reason for termination may vary, including policy lapse, surrender, maturity, or claim payout example: 2023-01-01 initialPaymentExpiryDate: type: string format: date description: The Initial Payment Amount Expiration Date refers to the deadline by which the initial premium payment must be made to keep the policy offer valid and ensure the policy goes into effect., if not received Policy will be Canceled due to no Premium Set at Issuance example: 2023-01-01 nextMonthiversaryDate: type: string format: date description: The Next Policy Monthiversary Date refers to the same day of each month that corresponds to the Policy Start Date, marking the monthly recurrence of the policy. It is used for monthly premium payments, cost deductions, cash value calculations, and interest crediting example: 2023-01-01 claimApprovalDate: type: string format: date description: The Claim Approval Date is the date when an insurance company officially approves a claim for payment after verifying the claim details, policy coverage, and required documentation example: 2023-01-01 certifiedReceivedDate: type: string description: The Certified Received Date refers to the date when the insurance company officially receives the certified death paperwork (such as a death certificate) required to process a life insurance claim. This date marks the beginning of the formal claims verification process format: date example: 2023-01-01 dateOfDeathReportedNotification: type: string format: date description: The Date of Death Reported / Notification refers to the date on which the insurance company is officially notified of the insured`s passing. This date is critical as it marks the start of the claims process and determines when the insurer begins reviewing the claim example: 2023-01-01 deferralEndDate: type: string format: date description: The Deferral End Date refers to the contractually set date on a deferred annuity or inherited IRA by which the policyholder must take action—either by starting withdrawals, annuitizing, or surrendering the policy. If no action is taken, the contract may auto-surrender, forcing a lump-sum payout or triggering Required Minimum Distributions (RMDs) example: 2023-01-01 conversionDate: type: string format: date description: The Conversion Date refers to the date on which an insurance or annuity contract is transferred or migrated from one platform, system, or policy type to another. This is commonly seen in policy administration system updates, carrier mergers, or policy conversions example: 2023-01-01 paidToDate: type: string format: date description: Paid to Date refers to the specific date through which a policyholder’s premium payments have fully covered the cost of insurance coverage on a life or annuity policy. It represents the end of the current paid coverage period and is critical for determining the policy's status (e.g., in-force, in grace period, or lapsed) example: 2023-01-01 paidUpDate: type: string format: date description: The date when all required premium payments on a life insurance policy have been made example: 2023-01-01 endowmentDate: type: string format: date description: The policy anniversary date on which the Level Term Period expires and the policy reaches endowment. example: 2023-01-01 Currency: type: string enum: - USD - CAD - AUD - NZD - GBP - EUR - CHF - JPY TestValues: type: object properties: guidelinePremium: $ref: "#/components/schemas/GuidelinePremium" modifiedEndowmentContract: $ref: "#/components/schemas/ModifiedEndowmentContract" AccountValues: type: object properties: beginningAccountValue: type: number description: The Account Value refers to the total cash value of a life insurance policy or annuity at the beginning of each transaction, including both loaned and unloaned amounts. It represents the policy’s accumulated value before deductions, withdrawals, or new transactions example: 161.81698 endingAccountValue: type: number description: The Current Account Value refers to the total cash value of a life insurance policy or annuity (including loaned and unloaned amounts) as of the last processed transaction. This value is used to determine the available account value (AV) for policyholders and is also the amount on which Fixed Interest is credited example: 161.81698 minimumRequiredAccountValue: type: number description: The Minimum Required Account Value refers to the lowest amount of account value that must be maintained in a life insurance policy or annuity to keep the contract active and prevent policy lapse. If the account value falls below this threshold, the policy may enter a grace period, require additional premium payments, or terminate. For some products this may be "0" example: 0 accountValueByPolicyYear: type: number description: The Account Value by Policy Year refers to the total account value at the beginning of each policy year, before any new transactions such as premium payments, withdrawals, loans, or interest credits are applied. This value helps track policy growth, cash value accumulation, and available funds over time example: 0 unloanedPortionOfAccountValue: type: number description: The Unloaned Portion of Account Value refers to the part of the total account value that is not affected by policy loans. Once a policy loan is taken, the total account value is split into loaned and unloaned portions, with the unloaned portion continuing to accrue interest and potential investment returns example: 161.81698 loanedPortionOfAccountValue: type: number description: The Loaned Portion of Account Value refers to the amount of a policy’s account value that is used as collateral for a policy loan. This amount is set aside from the Ending Account Value and is used to calculate loan interest accruals. The loaned portion is updated each time a new loan is processed example: 0 surrenderValue: type: number description: The Account Surrender Value refers to the amount an insurance company pays to the policyholder when they voluntarily cancel (surrender) their life insurance policy or annuity before its maturity or death benefit payout. This value is determined after deducting surrender charges, outstanding loans, and applicable fees from the policy’s total account value example: 161.81698 surrenderValueWithoutMarketValueAdjustment: type: number format: double description: Sum of money an insurance company pays to the policyholder or account owner upon the surrender of a policy/account without MVA value included example: 161.81698 surrenderValueWithZeroMarketValueAdjustment: type: number format: double description: For Valuation (Reserving purposes). The account surrender value where the surrender charge has been recalculated assuming $0 MVA example: 161.81698 guaranteedCashSurrenderValueFixed: type: number description: The Guaranteed Cash Surrender Value (Fixed) refers to the minimum cash value that a policyholder is assured to receive if they surrender their life insurance policy, regardless of market conditions. This amount is contractually defined and does not fluctuate with policy performance format: double example: 161.81698 guaranteedCashSurrenderValueIndexed: type: number description: The indexed amount of cash that the policyholder is guaranteed to receive upon surrendering the policy before its maturity.Only required for Annuity FIA Products format: double example: 161.81698 netAmountAtRisk: type: number description: The Net Amount at Risk (NAR) is the difference between the policy’s total death benefit and the policy’s account value (cash value). It represents the portion of the death benefit that the insurance company is at risk of paying out beyond the policyholder’s accumulated account value example: 16.81698 deemedAccountValue: type: number description: The Deemed Account Value refers to an adjusted account value used for specific policy calculations, regulatory compliance, or benefit determinations. It may differ from the actual account value due to adjustments for policy loans, fees, surrender charges, or regulatory requirements example: 16.81698 initialPremiumRequestAmount: type: number description: The Initial Premium Request Amount refers to the first premium payment made by the policyholder (party) to initiate coverage on a life insurance or annuity contract. This amount is required to activate the policy and begin accumulating benefits example: 99 initialPremiumAppliedAmount: type: number description: The Initial Premium Applied Amount refers to the portion of the initial premium payment that is officially applied to the policy after processing. This amount determines when the policy becomes active and how funds are allocated within the contract example: 99 initialPaymentAmountReceivedDate: type: string format: date description: The Initial Premium Amount Received Date refers to the date when the insurance company's home office officially receives the first premium payment for a life insurance policy or annuity contract. This date is crucial as it determines when the policy processing begins and may impact policy activation timelines example: 2023-01-01 cumulativePremiumSinceIssue: type: number description: The Cumulative Premium Since Issue refers to the total amount of premiums paid into a life insurance policy or annuity contract from the policy’s start date (issue date) to the present. This figure represents all premium contributions made by the policyholder over time example: 198 totalYearToDatePremiumAmount: type: number description: The Total (YTD) Premium Amount refers to the total premium applied to a life insurance policy or annuity contract within the current calendar or policy year, up to the present date. This value is used to track year-to-date contributions and ensure policy funding requirements are met example: 198 modifiedEndowmentContractAuthorization: type: string enum: - "true" - "false" description: MEC Authorization refers to the approval process required when a life insurance policy is classified as a Modified Endowment Contract (MEC). A MEC is a permanent life insurance policy that fails the IRS "7-Pay Test," resulting in different tax treatment of policy loans and withdrawals. MEC Authorization is typically required from the policyholder before processing transactions that could convert the policy into a MEC, ensuring they understand the tax consequences. projectedLapseIndicator: type: boolean description: The Projected Lapse Indicator is a forecast that indicates whether a life insurance policy is expected to lapse within the next policy year based on its current account value, premium payments, cost of insurance (COI), and other policy charges policyGainAmount: type: number description: The Policy Gain Amount is the difference between the policy’s total account value and the cost basis. It represents the amount of gain that may be subject to taxation if withdrawn or surrendered example: 0 uncollectedCharges: type: number description: Uncollected Charges refer to negative charges assessed when a policy is in a lapse condition due to insufficient funds in the policy’s account value. These charges represent policy fees, cost of insurance (COI), and other deductions that could not be collected because the policy had inadequate cash value example: 0 annualTargetPremium: type: number description: "The Annual Target Premium is the calculated premium amount used to determine commissions for agents and brokers. It represents the portion of the policy premium that qualifies for commission payments and is calculated based on specific monthly charges within the policy. The Annual Target Premium for the calculation of commissions will be calculated using the following formula: [(Monthly Expense Charge + Monthly Unit Charge + Monthly Coverage Charge + Children’s Term Insurance Rider Charge) ÷ (1 – Payment Charge)] × 12]" example: 99.9 format: double modalTargetPremium: type: number description: "The Modal Target Premium is the periodic premium amount used for commission calculations based on the chosen payment mode (e.g., monthly, quarterly, semi-annually, or annually). It is derived from the Annual Target Premium and represents how much of the target premium is allocated to each payment cycle. Modal Target Premium for the calculation of commissions will be calculated using the following formula: [(Monthly Expense Charge + Monthly Unit Charge + Monthly Coverage Charge + Children’s Term Insurance Rider Charge) ÷ (1 – Payment Charge)] × 12]" example: 99.9 format: double annualizedPremium: type: number description: Annualized Premium refers to the total amount of premium a policyholder is expected to pay over the course of a full year, assuming the policy remains active and all scheduled premium payments are made on time and in full. It is a standardized representation of premium income, regardless of payment mode (monthly, quarterly, semiannual, or annual) example: 99.99 format: double unearnedPremium: type: number description: Unearned Premium is the portion of a policyholder’s premium that has been paid in advance but corresponds to future coverage—i.e., insurance protection that has not yet been provided. It represents a liability on the insurer’s books because it reflects coverage that still needs to be delivered example: 99.99 format: double excessPremium: type: number format: double description: Excess Premium refers to the amount of premium paid into a life insurance or annuity policy that exceeds the allowable or intended limits set by the contract, regulatory testing (e.g., MEC or Guideline Premium Tests), or policy design (e.g., target or planned premiums). example: 99.99 outstandingLifetimePremium: type: number format: double description: Outstanding Lifetime Premium refers to the total amount of premium that remains unpaid over the lifetime of the policy, based on the expected premium schedule set at issue or during the most recent plan update. It represents the future premium obligation assuming the policyholder continues to pay until the end of the coverage period or maturity example: 99.99 suppressionIndicator: type: boolean description: The Suppression Indicator is a flag or marker used in policy administration systems to prevent certain actions, notifications, or transactions from being processed or displayed. It is commonly applied to billing, statements, reports, or policy updates based on specific business rules interestEarned: type: number format: double description: The Interest Earned refers to the amount of interest credited to a life insurance policy or annuity contract based on the accumulated account value. This interest may be guaranteed (fixed) or variable (market-based), depending on the policy type example: 99.12 totalNetWithdrawalSinceIssue: type: number description: Running total of all Net Withdrawals since policy issuance format: double totalGainWithdrawnSinceIssue: type: number description: Total of all earnings withdrawn since policy issue format: double employeeRetirementIncomeSecurityActIndicator: type: boolean description: ERISA Indicator is a field that specifies whether a policy or contract is subject to the Employee Retirement Income Security Act of 1974 (ERISA) — a federal law that governs certain employer-sponsored retirement and benefit plans in the U.S. cumulativePremiumReceived: type: number format: double description: Cumulative Premium Received refers to the total sum of premium payments that have been successfully received and applied to a policy from the date of issuance up to a given point in time. example: 99.99 previousModePremiumReceived: type: number format: double description: Previous Mode Premium Received refers to the actual premium amount collected during the prior billing mode period for a specific policy or coverage. This value reflects what was received for the most recently completed premium cycle (monthly, quarterly, semi-annual, or annual), immediately preceding the current period. example: 99.99 offageAmount: type: number format: double description: Offage Amount refers to the difference between the expected or scheduled value and the actual value applied or received on a policy transaction, typically related to premium payments, disbursements, or reserve adjustments. It acts as a variance indicator, flagging whether there is an overage or shortage that needs reconciliation. example: 99.99 totalGuaranteedCashSurrenderValue: type: number format: double description: The minimum guaranteed amount that the policyholder would receive upon surrendering the contract, as defined by the contracts guaranteed values. example: 161.81698 PartyRoles: type: object properties: partyRole: $ref: "#/components/schemas/PartyRole" partyRoleId: type: string 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 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_PI_1 startDate: type: string description: Date the Party was added to the Policy example: 2023-01-01 format: date endDate: type: string description: Date the Party was Terminated from the Policy example: 2023-01-01 format: date Parties: 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 format: date-time description: TBD example: 2023-01-01T12:00:00.000Z customerId: type: string description: Assigned by Sales Force and used by all platforms example: 0017b000010N4bCAAS insured: description: Reference to the Insured model allOf: - $ref: "#/components/schemas/Insured" version: type: number format: int32 example: 1 ProductType: type: string enum: - WHOLELIFE - UNIVERSALLIFE - VARIABLEUNIVERSALLIFE - VARIABLEWHOLELIFE - INDEXEDUNIVERSALLIFE - FIXEDANNUITY - FIXEDINDEXEDANNUITY - TERM - TERMWITHCASHVALUE DistributionType: type: string enum: - WIREHOUSE - REGISTEREDINVESTMENTADVISER - INDEPENDENTAGENCY - FINANCIALPLANNINGFIRM - FINANCIALINSTITUTION - BROKER_DEALER - THIRDPARTYDIRECTTOCONSUMER - BANKMARKET - BROKERAGE_INDEPENDENTMARKET - CAPTIVEMARKET - AFFILIATEDAGENCY - INSTITUTIONALMARKET - FARMERSMLEA HoldingForm: type: string enum: - INDIVIDUAL - GROUP - JOINTINDIVIDUAL GuidelinePremium: type: object properties: guidelinePremiumTestDate: type: string description: The Guideline Premium Test (GPT) Date refers to the last date on which the policy was tested to ensure compliance with the IRS`s Guideline Premium Test (GPT) for life insurance policies. This test ensures that the policy maintains its tax-advantaged status as a life insurance contract and does not become a Modified Endowment Contract (MEC). format: date example: 2023-01-01 definitionOfLifeInsurance: $ref: "#/components/schemas/DefinitionOfLifeInsurance" guidelineSinglePremium: type: number description: The Guideline Single Premium (GSP) refers to the maximum single premium payment that can be made into a life insurance policy without violating the IRS`s Guideline Premium Test (GPT). It is used to ensure that the policy qualifies as life insurance and maintains its tax-advantaged status format: double example: 65068.27 guidelineLevelPremium: type: number description: The Guideline Level Premium (GLP) is the maximum level (annual or periodic) premium that can be paid into a life insurance policy while maintaining compliance with the IRS`s Guideline Premium Test (GPT). It ensures that the policy remains classified as life insurance and retains its tax-advantaged status format: double example: 4695.39 guidelinePremiumLimit: type: number description: The Guideline Premium Limit represents the remaining cumulative amount of premium that can be paid into a life insurance policy over its lifetime without violating the IRS’s Guideline Premium Test (GPT). It helps ensure the policy maintains its tax-advantaged status as life insurance under Section 7702 of the Internal Revenue Code format: double example: 4695.39 guidelinePremiumLimitBreached: type: boolean description: Indicates whether the policy has breached the guideline premium limit. amountExcessToGuideline: type: number description: The Amount Excess to Guideline refers to the excess premium amount paid into a life insurance policy beyond the IRS-imposed limits under the Guideline Premium Test (GPT). This excess must be reimbursed or adjusted to ensure the policy maintains its tax-advantaged status and does not become a Modified Endowment Contract (MEC) format: double example: 0 totalGuidelineLevelPremiumSinceIssue: type: number description: The Total Guideline Level Premium (GLP) Since Issue refers to the cumulative sum of all guideline level premiums allowed from the policy’s issuance through the current policy anniversary date. It ensures that the policy remains compliant with the IRS Guideline Premium Test (GPT) and maintains its life insurance tax-advantaged status format: double example: 4695.39 ModifiedEndowmentContract: type: object properties: modifiedEndowmentContractTestDate: type: string format: date description: The MEC Test Date refers to the last date on which the life insurance policy was tested to determine whether it qualifies as a Modified Endowment Contract (MEC) under IRS regulations. This date is updated whenever a new MEC test is performed, ensuring the policy remains compliant with federal tax rules example: 2023-01-01 amountExcessToModifiedEndowmentContract: type: number format: double description: The Amount Excess to MEC refers to the excess premium amount paid into a life insurance policy beyond the IRS-imposed Modified Endowment Contract (MEC) limit. This excess must be reimbursed, adjusted, or restructured to prevent the policy from becoming a MEC, which would alter its tax treatment example: 0 modifiedEndowmentContractStatusDate: type: string format: date description: The MEC Status Date refers to the exact date when a life insurance policy is classified as a Modified Endowment Contract (MEC) or confirmed as non-MEC. This date is critical for determining how future withdrawals and policy loans will be taxed example: 2023-01-01 modifiedEndowmentContractStatus: type: boolean description: The MEC Status indicates whether a life insurance policy has been classified as a Modified Endowment Contract (MEC) under IRS regulations. This status determines the tax treatment of withdrawals, loans, and distributions from the policy sevenPayTestBasis: type: number format: double description: The 7-Pay Test Basis refers to the total cumulative premium paid into a life insurance policy during the first seven years (the 7-pay period), as measured against the IRS 7-Pay Test limit. This amount is used to determine whether the policy qualifies as a life insurance contract or is classified as a Modified Endowment Contract (MEC). example: 198 sevenPayPremium: type: number format: double description: The 7-Pay Premium refers to the maximum allowable premium that can be paid into a life insurance policy during the first seven years without triggering Modified Endowment Contract (MEC) status. It ensures that the policy remains a tax-advantaged life insurance contract rather than an investment vehicle example: 19807.51079 sevenPayStartDate: type: string format: date description: The 7-Pay Start Date / Material Change Date refers to the date when the 7-Pay Test period begins. This is initially set at policy issuance (matching the Policy Start Date) and resets whenever a material change occurs that affects the policy’s funding limits example: 2023-01-01 sevenPayPeriod: type: string format: date description: "The 7-Pay Period refers to the time frame during which the policy must comply with the 7-Pay Test to avoid Modified Endowment Contract (MEC) status. It starts on the 7-Pay Start Date (initially set at policy issuance) and lasts for seven years. The 7-Pay Period Expiration Date is calculated as: 7-Pay Expiration Date=7-Pay Start Date+7 Years" example: 2030-01-01 sevenPayLimit: type: number format: double description: The 7-Pay Limit refers to the maximum total premium that can be paid into a life insurance policy within the first seven years without triggering Modified Endowment Contract (MEC) status. It is the benchmark used in the 7-Pay Test to determine whether a policy remains a tax-advantaged life insurance contract example: 0 yearInPeriod: type: integer format: int32 description: The Year in Period refers to the current year within the seven-year time frame of the 7-Pay Test. It is crucial because the 7-Pay Limit increases each year, and the test is updated annually to ensure the policy remains within IRS limits example: 0 unnecessaryPremium: type: number format: double description: The Unnecessary Premium refers to the amount of premium that exceeds the limit set by the Nonforfeiture Premium Test (NPT Test). If premium payments are higher than the NPT limit, this amount is flagged as unnecessary premium, which may need to be refunded, adjusted, or redirected example: 232.12 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 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 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" DefinitionOfLifeInsurance: type: string enum: - GPT - CVAT 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 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 PolicySummary: type: object properties: id: type: string description: Internal ID of the snapshot document example: 657bddcddc353e5fc5f45acd event: type: string description: The transaction type of the current policy snapshot example: InterestCreditMatch effectiveDate: type: string description: Policy as of effective date, (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date policyNumber: type: string description: The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime example: POLICY1234567890 carrierId: type: string description: The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms example: EVGL product: $ref: "#/components/schemas/Product" qualificationType: type: string enum: - INDIVIDUALRETIREMENTACCOUNTREGULAR - INDIVIDUALRETIREMENTACCOUNTSPOUSAL - INDIVIDUALRETIREMENTACCOUNTROLLOVER - ROTHINDIVIDUALRETIREMENTACCOUNT - CUSTODIALINDIVIDUALRETIREMENTACCOUNT - CUSTODIALROTHINDIVIDUALRETIREMENTACCOUNT - CUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNT - QUALIFIED - NONQUALIFIED - SIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNT - INHERITEDINDIVIDUALRETIREMENTACCOUNT - INHERITEDROTHINDIVIDUALRETIREMENTACCOUNT - NONQUALIFIEDSTRETCH - INDIVIDUALRETIREMENTACCOUNTSIMPLE - Q403B - Q401K - Q401A - Q457B - PENSIONPLAN - CONVERTEDINDIVIDUALRETIREMENTACCOUNT - ROTH403B - CUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSION - KEOGH10 - CORPORATEPENSION - GROUPTAXSHELTEREDANNUITY - PROFITSHARING - TARGETBENEFIT - CORPORATEDEFERREDCOMPENSATION404 - EDUCATIONALINDIVIDUALRETIREMENTACCOUNT - QN457B - CONVERTED - SPOUSAL - CUSTODIAL - UNIFORMGIFTSORTRANSFERSTOMINORACT - CUSTODIALQUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT - CUSTODIALSIMPLEINDIVIDUALRETIREMENTACCOUNT - MONEYPURCHASEPENSIONPLAN - Q401G - Q412E3 - QUALIFIEDLONGEVITYANNUITYCONTRACTINDIVIDUALRETIREMENTACCOUNT - ROTH401K - VARIABLEUNIVERSALLIFENONQUALIFIED description: Qualification type of original policy being exchanged qualificationPlanTypeDescription: type: string description: TBD example: Qualification description policyStatus: $ref: "#/components/schemas/PolicyStatus" restrictStatus: $ref: "#/components/schemas/RestrictStatus" issueState: $ref: "#/components/schemas/State" policyDates: $ref: "#/components/schemas/PolicyDates" currency: $ref: "#/components/schemas/Currency" testValues: $ref: "#/components/schemas/TestValues" marketValueAdjustmentProduct: type: boolean description: Flag to identify whether the contract is MVA product or not accountValues: $ref: "#/components/schemas/AccountValues" partyRoles: type: array items: $ref: "#/components/schemas/PartyRoles" parties: type: array items: $ref: "#/components/schemas/Parties" ```