planCodestringrequired
policyNumberstringrequired
Policy Number
transactionTypestringrequired
Transaction Type
Allowed values:addressemailaddressphonebankaccountcommunicationpreference
Eligibility Check For Non-Financial Transaction
post
Path Parameters
Response
application/json
Response
application/json
Non Financial Eligibility Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/{transactionType}/eligibilitycheck
Authentication
Path Parameters
curl --request POST \
--url https://dev.api.zinnia.io/bpm/v1/policies////eligibilitycheck \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' application/json
{
"status": "success",
"quoteResponse": {
"status": "Success",
"message": "Request successful",
"data": {
"correlationId": "657b717dcf55411abf9ef067",
"transactionAmounts": {
"requestedAmount": 25,
"calculatedAmount": null,
"appliedAmount": 25
},
"policy": {
"id": "659fdafc075b950b7bd00feb",
"event": "InterestCreditMatch",
"carrierID": "SB",
"tpaID": "tpa-12345",
"lineOfBusiness": "LIFE",
"planName": "SB UL Premium Match",
"productType": "UNIVERSALLIFE",
"marketingName": "Everly Life",
"shortName": "SB UL",
"distribution": "THIRDPARTYDIRECTTOCONSUMER",
"banding": "NOPREMIUMBANDING",
"planCode": "SBFIXUL1",
"glPlanCode": "V2201",
"holdingForm": "INDIVIDUAL",
"renewable": null,
"qualificationType": "NONQUALIFIED",
"policyTerm": 20,
"policyYear": 1,
"monthOfYear": 1,
"policyNumber": "BPM0000001",
"policyStatus": "ACTIVE",
"nonforfeitureOption": null,
"issueType": "FULLUNDERWRITING",
"residenceState": "VT",
"issueState": "VT",
"premiumFrequency": "MONTHLY",
"currency": "USD",
"policyStartDate": "2023-12-27",
"applicationDate": "2023-12-27",
"issueDate": "2023-12-27",
"effectiveDate": "2024-01-11T00:00:00.000Z",
"contestabilityStartDate": "2023-12-27",
"contestabilityEndDate": "2025-12-26",
"policyDeliveryDate": "2023-12-27",
"previousPolicyAnniversaryDate": "2023-12-27",
"previousPolicyMonthiversaryDate": "2023-12-27",
"nextAnniversaryDate": "2024-12-27",
"maturityDate": "2125-12-26",
"policyTerminationDate": null,
"dateOfDeath": null,
"initialPaymentExpiryDate": "2024-01-10",
"nextMonthivesaryDate": "2024-01-27",
"costBasis": 105,
"costBasisDate": "2024-11-04",
"conversionDate": null,
"policyValues": {
"beginningAcctValue": 35.759837,
"endingAcctValue": 60.759837,
"minRequiredAcctValue": 0,
"acctValueByPolicyYear": 0,
"unloanedPortionOfAcctValue": 60.759837,
"loanedPortionOfAcctValue": 0,
"surrenderValue": 60.759837,
"netAmountAtRisk": 499920,
"initialPremiumRequestAmount": 80,
"initialPremiumAppliedAmount": 80,
"initialPaymentAmountReceivedDate": "2023-12-27",
"cumulativePremSinceIssue": 105,
"totalYTDPremiumAmount": 105,
"mecAuthorization": false,
"projectedLapseIndicator": null,
"policyGainAmount": 0
},
"loanValues": {
"totalLoanBalance": 0,
"totalLoanPrincipal": 0,
"loanPayoffAmount": 0,
"maxLoanAmount": 60.759837,
"minLoanAmount": 0,
"totalLoanAccruedInterest": 0,
"lastLoanInterestDueDate": null,
"totalNumberOfLoan": 0,
"loanInterestMethod": "ARREARS",
"totalYTDLoanTaken": 0,
"loanRepaymentType": null,
"minLoanRepayment": 1
},
"withDrawalValues": {
"totalWithdrawalAmount": 0,
"freeWithdrawalAmount": null,
"minWithdrawalAmount": 1,
"maxWithdrawalAmount": 60.759837,
"annualWithLimNoCovDecrease": null,
"maxWithdrawalRequestDuringVestingPeriod": 1,
"maxWithdrawalRequestAfterVestingPeriod": 12,
"totalYTDWithdrawalTaken": 0,
"numberOfWithdrawal": 0,
"withdrawalAllowedStartDate": "2023-12-27"
},
"testValues": {
"guidelinePremiumTestDate": "2024-11-04",
"definitionOfLifeInsurance": "GPT",
"guidelineSinglePremium": 68933.997746,
"guidelineLevelPremium": 5122.813261,
"amountExcessToGuideline": 0,
"totalGuidelineLevelPremiumSinceIssue": 5122.813261,
"mecTestDate": "2024-11-04",
"amountExcessToMEC": 0,
"mecStatusDate": null,
"mecStatus": false,
"sevenPayTestBasis": 185,
"sevenPayPremium": 25074.702628,
"sevenPayStartDate": "2023-12-27",
"sevenPayPeriod": "2030-12-26",
"sevenPayLimit": 25074.702628,
"yearInPeriod": 1
},
"timestamp": "2024-01-11T12:11:40.723Z",
"deathBenefit": {
"deathBenefitOption": "LEVEL",
"dboEffectiveDate": "2023-12-27",
"dboChangedEffectiveDate": null,
"deathBenefitAgeGuarantee": 38
},
"coverage": {
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.731Z",
"totalCoverageAmount": 500000,
"cumGrossDeathBenefitAmount": 500000,
"minCoverageAmount": 10000,
"maxCoverageAmount": 10000000,
"coverageChangeEffectiveDate": "2024-12-27",
"coverageBand": "BAND3",
"maxAnnualCoverageChangeAllowedPerPolicy": 1,
"minCoverageDecreaseAmount": 10000,
"maxCoverageDecreaseAmount": 490000,
"maxAgeNoCovAmountDecrease": 120,
"coverageAmountDecreaseAllowed": 1,
"minCoverageIncreaseAmount": 1,
"maxCoverageIncreaseAmount": 9500000,
"maxAgeNoCovAmountIncrease": 50,
"coverageAmountIncreaseAllowed": 1,
"coverageLayers": [
{
"coverageID": "Base_Coverage",
"coverageType": "Base",
"coverageName": "SB UL Premium Match",
"productCode": "SBFIXUL1",
"currentAmount": 500000,
"orignalCoverageAmount": 500000,
"minCoverageAmount": 10000,
"maxCoverageAmount": 10000000,
"grossDeathBenefitAmount": 500000,
"lowDeathBenefitAmount": 500000,
"coverageChangeAmount": 0,
"coverageEffectiveDate": "2023-12-27",
"coverageChangeEffectiveDate": null,
"coverageTerminationDate": null,
"unitOfCoverage": 500,
"valuePerUnitOfCoverage": 1000,
"premiumFrequency": null,
"guidelineSinglePremium": 68933.997746,
"guidelineLevelPremium": 5122.813261,
"sevenPayPremium": 25074.702628,
"coverageParticipants": [
{
"partyID": "Party_PI_1",
"issueAge": 18,
"riskClass": "Standard Tobacco",
"subStandardRating": "None",
"flatExtra": [
{
"flatExtraType": null,
"flatExtraDuration": 0,
"flatExtraAmount": 0,
"flatExtraStartDate": null
}
]
}
]
},
{
"coverageID": "Rider_SBLCHR",
"coverageType": "RIDER",
"coverageName": "Chronic Illness Accelerated Death Benefit Rider",
"productCode": "SBLCHR",
"currentAmount": null,
"orignalCoverageAmount": null,
"minCoverageAmount": null,
"maxCoverageAmount": null,
"grossDeathBenefitAmount": null,
"lowDeathBenefitAmount": null,
"coverageChangeAmount": 0,
"coverageEffectiveDate": "2023-12-27",
"coverageChangeEffectiveDate": null,
"coverageTerminationDate": "2125-12-26",
"unitOfCoverage": null,
"valuePerUnitOfCoverage": null,
"premiumFrequency": null,
"guidelineSinglePremium": null,
"guidelineLevelPremium": null,
"sevenPayPremium": null,
"coverageParticipants": [
{
"partyID": "Party_PI_1",
"issueAge": 18,
"riskClass": null,
"subStandardRating": null,
"flatExtra": []
}
]
},
{
"coverageID": "Rider_SBLCRI",
"coverageType": "RIDER",
"coverageName": "Critical Illness Accelerated Death Benefit Rider",
"productCode": "SBLCRI",
"currentAmount": null,
"orignalCoverageAmount": null,
"minCoverageAmount": null,
"maxCoverageAmount": null,
"grossDeathBenefitAmount": null,
"lowDeathBenefitAmount": null,
"coverageChangeAmount": 0,
"coverageEffectiveDate": "2023-12-27",
"coverageChangeEffectiveDate": null,
"coverageTerminationDate": "2125-12-26",
"unitOfCoverage": null,
"valuePerUnitOfCoverage": null,
"premiumFrequency": null,
"guidelineSinglePremium": null,
"guidelineLevelPremium": null,
"sevenPayPremium": null,
"coverageParticipants": [
{
"partyID": "Party_PI_1",
"issueAge": 18,
"riskClass": null,
"subStandardRating": null,
"flatExtra": []
}
]
},
{
"coverageID": "Rider_SBLTRM",
"coverageType": "RIDER",
"coverageName": "Terminal Illness Accelerated Death Benefit Rider",
"productCode": "SBLTRM",
"currentAmount": null,
"orignalCoverageAmount": null,
"minCoverageAmount": null,
"maxCoverageAmount": null,
"grossDeathBenefitAmount": null,
"lowDeathBenefitAmount": null,
"coverageChangeAmount": 0,
"coverageEffectiveDate": "2023-12-27",
"coverageChangeEffectiveDate": null,
"coverageTerminationDate": "2125-12-26",
"unitOfCoverage": null,
"valuePerUnitOfCoverage": null,
"premiumFrequency": null,
"guidelineSinglePremium": null,
"guidelineLevelPremium": null,
"sevenPayPremium": null,
"coverageParticipants": [
{
"partyID": "Party_PI_1",
"issueAge": 18,
"riskClass": null,
"subStandardRating": null,
"flatExtra": []
}
]
},
{
"coverageID": "Rider_OPR",
"coverageType": "RIDER",
"coverageName": "Overloan Protection Rider",
"productCode": "SBLOPR",
"currentAmount": null,
"orignalCoverageAmount": null,
"minCoverageAmount": null,
"maxCoverageAmount": null,
"grossDeathBenefitAmount": null,
"lowDeathBenefitAmount": null,
"coverageChangeAmount": 0,
"coverageEffectiveDate": "2023-12-27",
"coverageChangeEffectiveDate": null,
"coverageTerminationDate": "2125-12-26",
"unitOfCoverage": null,
"valuePerUnitOfCoverage": null,
"premiumFrequency": null,
"guidelineSinglePremium": null,
"guidelineLevelPremium": null,
"sevenPayPremium": null,
"coverageParticipants": [
{
"partyID": "Party_PI_1",
"issueAge": 18,
"riskClass": null,
"subStandardRating": null,
"flatExtra": []
}
]
}
],
"version": 1
},
"riders": [
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.729Z",
"type": "RIDER",
"riderName": "Chronic Illness Accelerated Death Benefit Rider",
"riderElected": "ELECTED",
"riderCode": "SBLCHR",
"effectiveDate": "2023-12-27",
"terminationDate": "2125-12-26",
"status": "ACTIVE",
"coverageID": "Rider_SBLCHR",
"amount": null,
"riderParticipant": [
{
"insuredID": "Party_PI_1",
"insuredAgeAtIssue": 18
}
],
"charge": {
"chargeID": null,
"value": null,
"effectiveRate": null,
"nextEvaluationDate": null
},
"riderExerciseCharge": null,
"maxChronicIllnessBenefitPct": 50,
"maxPeriodicPaymentPeriod": 120,
"claimStatus": null,
"riderExerciseChargeRate": null,
"nextEvaluationDate": null,
"riderPaymentDate": null,
"riderPaymentAmount": null,
"paymentMode": null,
"paymentOption": null,
"maxCriticalIllnessBenefitPct": null,
"t1MaxCriticalIllnessBenefitPct": null,
"t1MaxCriticalIllnessBenefitAmount": null,
"t2MaxCriticalIllnessBenefitPct": null,
"t2MaxCriticalIllnessBenefitAmount": null,
"t1CriticalRiderPaymentDate": null,
"t1CriticalRiderPaymentAmount": null,
"t2CriticalRiderPaymentDate": null,
"t2CriticalRiderPaymentAmount": null,
"terminalRiderPaymentAmount": null,
"version": 1
},
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.729Z",
"type": "RIDER",
"riderName": "Critical Illness Accelerated Death Benefit Rider",
"riderElected": "ELECTED",
"riderCode": "SBLCRI",
"effectiveDate": "2023-12-27",
"terminationDate": "2125-12-26",
"status": "ACTIVE",
"coverageID": "Rider_SBLCRI",
"amount": null,
"riderParticipant": [
{
"insuredID": "Party_PI_1",
"insuredAgeAtIssue": 18
}
],
"charge": {
"chargeID": null,
"value": null,
"effectiveRate": null,
"nextEvaluationDate": null
},
"riderExerciseCharge": null,
"maxChronicIllnessBenefitPct": null,
"maxPeriodicPaymentPeriod": null,
"claimStatus": null,
"riderExerciseChargeRate": null,
"nextEvaluationDate": null,
"riderPaymentDate": null,
"riderPaymentAmount": null,
"paymentMode": null,
"paymentOption": null,
"maxCriticalIllnessBenefitPct": 50,
"t1MaxCriticalIllnessBenefitPct": 5,
"t1MaxCriticalIllnessBenefitAmount": 5000,
"t2MaxCriticalIllnessBenefitPct": 50,
"t2MaxCriticalIllnessBenefitAmount": 500000,
"t1CriticalRiderPaymentDate": null,
"t1CriticalRiderPaymentAmount": null,
"t2CriticalRiderPaymentDate": null,
"t2CriticalRiderPaymentAmount": null,
"terminalRiderPaymentAmount": null,
"version": 1
},
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.729Z",
"type": "RIDER",
"riderName": "Overloan Protection Rider",
"riderElected": "ELECTED",
"riderCode": "SBLOPR",
"effectiveDate": "2023-12-27",
"terminationDate": "2125-12-26",
"status": "ACTIVE",
"coverageID": "Rider_SBLOPR",
"amount": null,
"riderParticipant": [
{
"insuredID": "Party_PI_1",
"insuredAgeAtIssue": 18
}
],
"charge": {
"chargeID": null,
"value": null,
"effectiveRate": null,
"nextEvaluationDate": null
},
"riderExerciseCharge": null,
"maxChronicIllnessBenefitPct": null,
"maxPeriodicPaymentPeriod": null,
"claimStatus": null,
"riderExerciseChargeRate": null,
"nextEvaluationDate": null,
"riderPaymentDate": null,
"riderPaymentAmount": null,
"paymentMode": null,
"paymentOption": null,
"maxCriticalIllnessBenefitPct": null,
"t1MaxCriticalIllnessBenefitPct": null,
"t1MaxCriticalIllnessBenefitAmount": null,
"t2MaxCriticalIllnessBenefitPct": null,
"t2MaxCriticalIllnessBenefitAmount": null,
"t1CriticalRiderPaymentDate": null,
"t1CriticalRiderPaymentAmount": null,
"t2CriticalRiderPaymentDate": null,
"t2CriticalRiderPaymentAmount": null,
"terminalRiderPaymentAmount": null,
"version": 1
},
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.729Z",
"type": "RIDER",
"riderName": "Terminal Illness Accelerated Death Benefit Rider",
"riderElected": "ELECTED",
"riderCode": "SBLTRM",
"effectiveDate": "2023-12-27",
"terminationDate": "2125-12-26",
"status": "ACTIVE",
"coverageID": "Rider_SBLTRM",
"amount": null,
"riderParticipant": [
{
"insuredID": "Party_PI_1",
"insuredAgeAtIssue": 18
}
],
"charge": {
"chargeID": null,
"value": null,
"effectiveRate": null,
"nextEvaluationDate": null
},
"riderExerciseCharge": null,
"maxChronicIllnessBenefitPct": null,
"maxPeriodicPaymentPeriod": null,
"claimStatus": null,
"riderExerciseChargeRate": null,
"nextEvaluationDate": null,
"riderPaymentDate": null,
"riderPaymentAmount": null,
"paymentMode": null,
"paymentOption": null,
"maxCriticalIllnessBenefitPct": null,
"t1MaxCriticalIllnessBenefitPct": null,
"t1MaxCriticalIllnessBenefitAmount": null,
"t2MaxCriticalIllnessBenefitPct": null,
"t2MaxCriticalIllnessBenefitAmount": null,
"t1CriticalRiderPaymentDate": null,
"t1CriticalRiderPaymentAmount": null,
"t2CriticalRiderPaymentDate": null,
"t2CriticalRiderPaymentAmount": null,
"terminalRiderPaymentAmount": null,
"version": 1
}
],
"systematicPrograms": [
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.730Z",
"arrType": "PAYMENT",
"arrangementID": "Arr_1",
"allocationOptionType": "DOLLAR",
"reason": "PREMIUMREASON",
"numberOfOccurrence": null,
"loanRepaymentType": null,
"disbursementType": null,
"status": "ACTIVE",
"paymentForm": "EFT",
"frequency": "MONTHLY",
"requestedDate": "2023-12-27",
"startDate": "2024-01-27",
"endDate": "2043-11-27",
"lastActivityDate": "2023-12-27",
"nextActivityDate": "2024-01-27",
"amountType": "AMOUNT",
"amount": 80,
"payors": [
{
"partyRole": "Payee",
"partyID": "Party_PI_1",
"bankId": "Bank_1",
"percentage": 100
}
],
"payees": null,
"version": 1
}
],
"policyFeatures": [
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.733Z",
"featureType": "freeLook",
"startDate": null,
"endDate": "2024-01-26",
"status": null,
"period": 30,
"effectiveDate": null,
"totalRequiredAmount": null,
"totalMinRequiredAmount": null,
"paymentAmount": null,
"totalPaymentAmount": null,
"uwDecision": null,
"approvalDate": null,
"version": 1
},
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.733Z",
"featureType": "lapseAssessment",
"startDate": null,
"endDate": null,
"status": false,
"period": null,
"effectiveDate": null,
"totalRequiredAmount": null,
"totalMinRequiredAmount": null,
"paymentAmount": null,
"totalPaymentAmount": null,
"uwDecision": null,
"approvalDate": null,
"version": 1
},
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.733Z",
"featureType": "lapseProtection",
"startDate": "2023-12-27",
"endDate": "2043-12-26",
"status": null,
"period": 20,
"effectiveDate": null,
"totalRequiredAmount": null,
"totalMinRequiredAmount": null,
"paymentAmount": 51.78,
"totalPaymentAmount": 51.78,
"uwDecision": null,
"approvalDate": null,
"version": 1
},
{
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.733Z",
"featureType": "reinstatement",
"startDate": null,
"endDate": null,
"status": null,
"period": null,
"effectiveDate": null,
"totalRequiredAmount": null,
"totalMinRequiredAmount": null,
"paymentAmount": null,
"totalPaymentAmount": null,
"uwDecision": null,
"approvalDate": null,
"version": 1
}
],
"allocation": {
"id": null,
"policyDetailsId": null,
"ledgerDocId": null,
"timestamp": "2024-01-11T12:11:40.732Z",
"investmentType": "INVESTMENTFUND",
"modelName": null,
"modelID": null,
"fundAllocationsInvestments": [
{
"fundID": "FundAccount1",
"fundName": "Everly Fixed Fund UL2",
"fundAccountType": null,
"allocPercent": 100,
"startDate": "2023-12-27",
"endDate": null
}
],
"funds": [
{
"fundAccountType": null,
"fundID": "FundAccount1",
"fundName": "Fixed Fund",
"glFundCode": "V2201",
"totalFundValue": 60.759837,
"fundSegments": [
{
"segmentID": "1",
"fundID": null,
"originalDepositAmount": 80,
"originalDepositDate": "2023-12-27",
"depositDate": "2024-11-04",
"depositAmount": 25,
"currentAmount": 60.759837,
"renewalDate": null,
"numberOfUnits": null,
"sweepAccountID": null,
"startDate": "2023-12-27",
"endDate": null
}
]
}
],
"matchSegment": {
"segmentID": "Match1",
"matchAccountValue": 1.05129,
"cumulativeMatchPaymentAmount": 1.05,
"ytdMatchValue": 1.05,
"maxLifeTimeVestingAmount": 500,
"maxAnnVestingAmount": 500,
"minPaymentsForMatch": 0,
"matchVestingDate": "2034-12-26",
"glFundCode": "V2201",
"vestingPeriod": 10
},
"loanSegments": [],
"version": 1
},
"version": 40
}
},
"error": null
}
}Freelook cancellation request
If freelook endDate is less than or equal to policy effective Date, cancel the policy based on the request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
FreeLookCancellationRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
post/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation/eligibilitycheck
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
curl --request POST \
--url https://dev.api.zinnia.io/policy/v1/transactions///freelookcancellation/eligibilitycheck \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}' application/json
{
"correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
"caseId": "CA0000369469",
"caseStatus": "IN_PROGRESS"
}Address Change Request
put
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
PartyId for which address need to be updated it be avaible under SOR Policy Details
addressIdinteger(int32)required
AddressId for which address need to be updated it be avaible under SOR Policy Details
Body
application/json
Body
application/json
AddressChangeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
preferredAddressIndicatorstringrequired
Indicates whether the address being added should be set as default or not.
Allowed values:YESNO
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
addressobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
put/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address/{addressId}
Authentication
Path Parameters
Body
{
"preferredAddressIndicator": "YES",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}{
"preferredAddressIndicator": "YES",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}
curl --request PUT \
--url https://dev.api.zinnia.io/policy/v1/transactions///parties//address/ \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
"preferredAddressIndicator": "YES",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}' application/json
{
"correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
"caseId": "CA0000369469",
"caseStatus": "IN_PROGRESS"
}Create new address based on request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
Body
application/json
Body
application/json
AddressChangeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
preferredAddressIndicatorstringrequired
Indicates whether the address being added should be set as default or not.
Allowed values:YESNO
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
addressobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
post/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address
Authentication
Path Parameters
Body
{
"preferredAddressIndicator": "YES",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}{
"preferredAddressIndicator": "YES",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}
curl --request POST \
--url https://dev.api.zinnia.io/policy/v1/transactions///parties//address \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
"preferredAddressIndicator": "YES",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}' application/json
{
"correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
"caseId": "CA0000369469",
"caseStatus": "IN_PROGRESS"
}Create new Emailaddress based on request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
Body
application/json
Body
application/json
EmailChangeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
emailobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA00000022023
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
Response
application/json
Request accepted successfully and is being processed.
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
post/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddress
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"email": {
"startDate": "startDate",
"emailType": "PERSONAL",
"emailAddress": "will.smith@gmail.com"
}
}{
"effectiveDate": "effectiveDate",
"email": {
"startDate": "startDate",
"emailType": "PERSONAL",
"emailAddress": "will.smith@gmail.com"
}
}
curl --request POST \
--url https://dev.api.zinnia.io/policy/v1/transactions///parties//emailaddress \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
"effectiveDate": "effectiveDate",
"email": {
"startDate": "startDate",
"emailType": "PERSONAL",
"emailAddress": "will.smith@gmail.com"
}
}' application/json
{
"correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
"caseId": "CA0000369469",
"caseStatus": "IN_PROGRESS"
}