Search
K
Policy

CaseResponse

object
caseErrorCodestringrequired
caseErrorDescriptionstringrequired
Example
{
  "caseErrorCode": "caseErrorCode",
  "caseErrorDescription": "caseErrorDescription"
}

Schedule

object
amountTypestringrequired
amountnumberrequired
nextProgramDatestringrequired
Example
{
  "amountType": "amountType",
  "amount": 0,
  "nextProgramDate": "nextProgramDate"
}

RemovePayor

object
partyRolestringrequired
partyIDstringrequired
Example
{
  "partyRole": "partyRole",
  "partyID": "partyID"
}

FinancialTransaction

object
idstringrequired
policyDetailsIdstringrequired
ledgerDocIdstringrequired
timestampstring(date-time)required
policyNumberstringrequired
transactionIDstringrequired
externalTransactionIDstringrequired
correlationIDstringrequired
parentIDstringrequired
transTypestringrequired
transactionTypestring

Allowed values:PartialWithdrawalOneTimeFullSurrenderNewLoanOneTimePremiumSystematicProgramUpdateLoanRepaymentOneTimeSystematicLoanRepaymentSetup

requestDatestringrequired
effectiveDatestringrequired
processDatestringrequired
statusstringrequired
actionstringrequired
outcomebooleanrequired
outcomeStatusstringrequired
outcomeCodestringrequired
outcomeCodeDescriptionstringrequired
transactionReasonstringrequired
processNonumberrequired
transactionAmountsobjectrequired
Show Child Parameters
chargesarray[object]required
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
fundDistributionsarray[object]required
Show Child Parameters
fundActivityarray[object]required
Show Child Parameters
matchActivityobjectrequired
Show Child Parameters
loanActivityobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]required
Show Child Parameters
taxWithheldAmountsarray[object]required
Show Child Parameters
payorarray[object]required
Show Child Parameters
payeeOrBeneficiaryarray[object]required
Show Child Parameters
lifecycleNonumberrequired
reverseInitiatorboolean

Default:false

caseIDstringrequired
partyIDstringrequired
requestTypestring

Allowed values:QuoteActual

caseRequestobjectrequired
Show Child Parameters
caseResponseobjectrequired
Show Child Parameters
programTypestringrequired
systematicProgramIDstringrequired
frequencystringrequired
startDatestringrequired
endDatestringrequired
scheduleobjectrequired
Show Child Parameters
removePayorobjectrequired
Show Child Parameters
versionstringrequired
Example
{
  "id": "id",
  "policyDetailsId": "policyDetailsId",
  "ledgerDocId": "ledgerDocId",
  "timestamp": "timestamp",
  "policyNumber": "policyNumber",
  "transactionID": "transactionID",
  "externalTransactionID": "externalTransactionID",
  "correlationID": "correlationID",
  "parentID": "parentID",
  "transType": "transType",
  "transactionType": "PartialWithdrawalOneTime",
  "requestDate": "requestDate",
  "effectiveDate": "effectiveDate",
  "processDate": "processDate",
  "status": "status",
  "action": "action",
  "outcome": false,
  "outcomeStatus": "outcomeStatus",
  "outcomeCode": "outcomeCode",
  "outcomeCodeDescription": "outcomeCodeDescription",
  "transactionReason": "transactionReason",
  "processNo": 0,
  "transactionAmounts": {
    "requestedAmount": 100.41,
    "amountType": "AMOUNT",
    "disbursementType": "GROSS",
    "disbursementPaymentForm": "DTCC",
    "distributionCode": "DEFAULT",
    "loanType": "PREFERRED",
    "loanInterestType": "FIXED",
    "paymentAmount": 100.31,
    "appliedAmount": 100.29,
    "freeAppliedAmount": 100.18,
    "calculatedAmount": 100.19,
    "totalChargeAmount": 100.41,
    "taxableAmount": 100.23,
    "deathClaimPayoutPreStateSpecificInterest": 1000.91,
    "claimStatutoryInterestAmount": 1000.41,
    "deathBenefitInterestCalculatedFromDate": "DATEOFDEATH",
    "claimStatutoryInterestRate": 1000.51,
    "claimCode": "DEATH",
    "distributionInternalRevenueServiceCode": "LD",
    "offageAmount": 100.81,
    "excessPremium": 100.91,
    "targetPremium": 100.19,
    "netPaymentAmount": 48000.28,
    "retainedCommissionAmount": 2000.29
  },
  "charges": [
    {
      "chargeType": "COSTOFINSURANCE",
      "chargeWaiverIndicator": "Yes",
      "chargeWaiverReason": "100"
    }
  ],
  "fundAllocation": {
    "allocationOption": "PRORATA"
  },
  "fundDistributions": [
    {
      "fundID": "FundAccount1",
      "fundName": "Fund1",
      "totalFundValue": 100,
      "requestedAmount": 100,
      "fundDistributionSegments": [
        {
          "segmentID": "segment1",
          "currentAmount": 1000,
          "requestedAmount": 100
        }
      ]
    }
  ],
  "fundActivity": [
    {
      "fundID": "FundAccount1",
      "fundName": "Fund Account 1",
      "fundAccountType": "FIXED",
      "totalFundValue": 0,
      "appliedAmount": 100,
      "fundActivitySegments": [
        {
          "segmentID": "segment1",
          "currentAmount": 100,
          "segmentActivity": {
            "segmentID": "segment1",
            "appliedRate": 100,
            "appliedAmount": 100,
            "appliedInterest": 100
          }
        }
      ]
    }
  ],
  "matchActivity": {
    "currentAmount": 100
  },
  "loanActivity": {
    "totalLoanBalance": 100,
    "totalLoanAccruedInterest": 100,
    "repaymentInterestAmount": 100,
    "loanSegments": [
      {
        "segmentID": "Segment1",
        "loanBalance": 100,
        "loanAccruedInterest": 100,
        "repaymentInterestAmount": 100
      }
    ]
  },
  "taxWithholdingInstructions": [
    {
      "partyId": "Party_PI_1",
      "partyRole": "OWNER",
      "taxWithholdingType": "FEDERAL",
      "taxRateToUse": "NOWITHHOLDINGELECTED",
      "filingStatus": "SINGLE",
      "dollar": 10,
      "percentage": 50,
      "exemptions": 0,
      "taxJurisdiction": "USA_WY",
      "contribution": "NOTAPPLICABLE",
      "taxFormType": "T1035COSTBASIS",
      "w4p": {
        "totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities": 12.12,
        "totalAmountOfClaimsAndOtherCredits": 213.73,
        "otherIncome": 144.53,
        "otherDeduction": 42.83
      }
    }
  ],
  "taxWithheldAmounts": [
    {
      "partyRole": "OWNER",
      "partyId": "Party_PI_1",
      "taxWithholdingType": "FEDERAL",
      "withheldAmount": 100,
      "withheldTaxableAmount": 100,
      "taxableFlag": true,
      "appliedTaxRate": 100
    }
  ],
  "payor": [
    {
      "id": "id",
      "policyDetailsId": "policyDetailsId",
      "ledgerDocId": "ledgerDocId",
      "timestamp": "timestamp",
      "policyNumber": "policyNumber",
      "partyMasterID": "partyMasterID",
      "partyID": "partyID",
      "idReferenceNo": "idReferenceNo",
      "beneficiaryPercentage": 0,
      "partyType": "partyType",
      "url": {
        "website": "https://zinnialive.com/",
        "carrierLogin": "https://zinnialive.com/",
        "agentLogin": "https://zinnialive.com/",
        "customerLogin": "https://wellabe.mypolicyview.com/"
      },
      "firstName": "firstName",
      "middleName": "middleName",
      "lastName": "lastName",
      "fullName": "fullName",
      "prefix": "prefix",
      "suffix": "suffix",
      "gender": "gender",
      "dateOfBirth": "dateOfBirth",
      "attainedAge": 0,
      "birthCountry": "birthCountry",
      "birthState": "birthState",
      "dba": "dba",
      "abbrName": "abbrName",
      "orgCode": "orgCode",
      "entityType": "entityType",
      "trustDate": "trustDate",
      "trustType": "trustType",
      "prefCommunicationType": "prefCommunicationType",
      "formerName": {
        "firstName": "Karen",
        "middleName": "Anne",
        "lastName": "Bates",
        "prefix": "MR",
        "suffix": "JR",
        "fullName": "Karen Anne Bates",
        "abbreviatedName": "TBD",
        "doingBusinessAs": "TBD"
      },
      "identifications": [
        {
          "identificationId": "1",
          "startDate": "2023-01-01",
          "endDate": "2023-01-01",
          "identificationType": "PASSPORT",
          "identificationKey": "666-50-8548",
          "identificationValue": "666-50-8548",
          "identificationDescription": "Employee Control Number",
          "issueState": "AA",
          "issueCountry": "US"
        }
      ],
      "addresses": [
        {
          "startDate": "2023-01-01",
          "endDate": "2023-01-01",
          "addressType": "RESIDENCE",
          "addressLine1": "1112 Pickle Street",
          "addressLine2": "South Jersey",
          "addressLine3": "1234 Post box",
          "city": "Garden City",
          "state": "AA",
          "zipCode": "67846",
          "zipCodeExtension": "23",
          "country": "US",
          "isPreferred": true,
          "addressId": "1",
          "preferredAddress": false
        }
      ],
      "phones": [
        {
          "startDate": "2023-01-01",
          "endDate": "2023-01-01",
          "phoneType": "MOBILE",
          "countryCode": "9",
          "areaCode": "973",
          "dialNumber": "765789",
          "extension": "null",
          "bestTime": "null",
          "timezone": "null",
          "isPreferred": true,
          "phoneId": "1"
        }
      ],
      "emails": [
        {
          "startDate": "2023-01-01",
          "endDate": "2023-01-01",
          "emailType": "PERSONAL",
          "emailAddress": "will.smith@gmail.com",
          "isPreferred": true,
          "emailId": "1"
        }
      ],
      "bankDetails": [
        {
          "recordID": 0,
          "appliesToPartyID": "appliesToPartyID",
          "financialInstitutionPartyID": "financialInstitutionPartyID",
          "startDate": "startDate",
          "endDate": "endDate",
          "nameOnAccount": "nameOnAccount",
          "accountStatus": "accountStatus",
          "accountType": "accountType",
          "accountNumber": "accountNumber",
          "routingNumber": "routingNumber",
          "ibaNumber": "ibaNumber",
          "branchName": "branchName",
          "accountPurpose": "accountPurpose",
          "branchAddress": {
            "startDate": "2023-01-01",
            "endDate": "2023-01-01",
            "addressType": "RESIDENCE",
            "addressLine1": "1112 Pickle Street",
            "addressLine2": "South Jersey",
            "addressLine3": "1234 Post box",
            "city": "Garden City",
            "state": "AA",
            "zipCode": "67846",
            "zipCodeExtension": "23",
            "country": "US",
            "isPreferred": true,
            "addressId": "1",
            "preferredAddress": false
          },
          "branchPhoneNumber": "branchPhoneNumber"
        }
      ],
      "dateOfDeath": "dateOfDeath",
      "stateOfDeath": "stateOfDeath",
      "disabled": false,
      "disabilityStartDate": "disabilityStartDate",
      "riskDetails": {
        "existingLifeInsurance": false,
        "existingLifeInsuranceAmount": 0,
        "replaceLifeInsurance": false,
        "pendingOrPlanToBuyAdditional": false,
        "isDependent": false,
        "employed": false,
        "employmentStatus": "employmentStatus",
        "occupation": "occupation",
        "householdIncome": 0
      },
      "financialInstitutionPartyID": "financialInstitutionPartyID",
      "percentage": 0,
      "version": 0
    }
  ],
  "payeeOrBeneficiary": [
    {
      "partyId": "Party_PI_1",
      "paymentForm": "DTCC",
      "allocationPercentage": 100,
      "bankId": "Bank_1"
    }
  ],
  "lifecycleNo": 0,
  "reverseInitiator": false,
  "caseID": "caseID",
  "partyID": "partyID",
  "requestType": "Quote",
  "caseRequest": {
    "caseCorrelationID": "caseCorrelationID",
    "caseId": "caseId",
    "caseStatus": "caseStatus",
    "requestSource": "requestSource",
    "carrierID": "carrierID",
    "productID": "productID",
    "userID": "userID",
    "policyNumber": "policyNumber"
  },
  "caseResponse": {
    "caseErrorCode": "caseErrorCode",
    "caseErrorDescription": "caseErrorDescription"
  },
  "programType": "programType",
  "systematicProgramID": "systematicProgramID",
  "frequency": "frequency",
  "startDate": "startDate",
  "endDate": "endDate",
  "schedule": {
    "amountType": "amountType",
    "amount": 0,
    "nextProgramDate": "nextProgramDate"
  },
  "removePayor": {
    "partyRole": "partyRole",
    "partyID": "partyID"
  },
  "version": "version"
}

PartialWithdrawalTransactionAmounts

object
requestedAmountnumber
amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

disbursementTypestring

Allowed values:GROSSNETNETNET

disbursementPaymentFormstring

Allowed values:DTCCEFTACHCHECKWIRE

Example
{
  "requestedAmount": 0,
  "amountType": "AMOUNT",
  "disbursementType": "GROSS",
  "disbursementPaymentForm": "DTCC"
}