Search
K
Illustration

Age-Calculation-Response

object
ageinteger

Calculated age

Example:35

monthsSinceLastBirthdayinteger

Number of months since last birthday

Example
{
  "age": 35,
  "monthsSinceLastBirthday": 0
}

Age-Calculation-Method

string

Age calculation method - AGE_LAST for age at last birthday, AGE_NEAREST for age at nearest birthday

Allowed values:AGE_LASTAGE_NEAREST

Example
"AGE_LAST"

Illustration Request

Fundamental Illustration request schema. See the schema for a specific product

calculationTypestringrequired

Type of calculation. Only SINGLE_ILLUSTRATION triggers a PDF to be generated.

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTIONINITIAL_QUOTE

Example:QUICK_QUOTE

sourcestring

Source of the request

Example:ZINNIA

illustrationRequestDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2025-05-13

jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

coveragesarray[object]required

A benefit conferred to a group of one or more participants

Show Child Parameters
partiesAny Of
arrayrequiredunique-items

Must have at least one party representing the Insured participant

>= 1 items

Non-Insured Partyobject

Represents a party with a roleCode other than INSURED

Show Child Parameters
optionsobject

Fundamental Options schema. Some products may have product-specific Options.

Show Child Parameters
reportsobject
Show Child Parameters
Example
{
  "calculationType": "QUICK_QUOTE",
  "source": "ZINNIA",
  "illustrationRequestDate": "2025-05-13",
  "jurisdiction": "AK",
  "planCode": "EG123",
  "coverages": [
    {
      "coverageId": "BASE_COVERAGE",
      "riderYears": 10,
      "currentAmount": 1000,
      "participants": [
        {
          "issueAge": 30,
          "participantId": "2ad51ecf-9923-437f-a6f0-70968e464cdb",
          "underwritingClass": "ULTRANONTOBACCO",
          "subStandardRating": "TABLEA",
          "flatExtra": [
            {
              "type": "PERMANENT",
              "amount": 1000,
              "duration": 12,
              "durationType": "YEARS",
              "startDate": "2025-05-13"
            }
          ]
        }
      ]
    }
  ],
  "parties": [
    {
      "partyId": "95f5ece9-e40b-450b-ad39-daa217894e69",
      "partyTypeCode": "INDIVIDUAL",
      "gender": "MALE",
      "dateOfBirth": "1990-05-13",
      "firstName": "John",
      "middleName": "Frederick",
      "lastName": "Doe",
      "suffix": "Jr.",
      "address": {
        "addressLine1": "123 Charter Oak",
        "addressLine2": "Suite 456",
        "city": "Manchester",
        "state": "CT",
        "zipCode": "123456"
      },
      "email": "person@example.com",
      "phoneType": "HOME",
      "phone": "1238675309",
      "identification": {
        "identificationType": "PASSPORT",
        "identificationKey": "ECN",
        "identificationDescription": "ECN",
        "identificationValue": "ECN"
      },
      "roleCode": "OWNER"
    }
  ],
  "options": {
    "revisedIllustration": true,
    "solveFor": "PREMIUM",
    "fixedCostPeriod": 10,
    "paymentMode": "DAILY",
    "discountIndicator": "MULTIPRODUCT",
    "paymentMethod": "DTCC",
    "premiumDuration": 10,
    "premiumDurationOption": "YEARS",
    "faceAmount": {
      "frequency": "DAILY",
      "basis": "AGE",
      "sequence": [
        {
          "from": 1,
          "through": 10,
          "value": 250000
        }
      ]
    },
    "premium": {
      "frequency": "DAILY",
      "basis": "AGE",
      "sequence": [
        {
          "from": 1,
          "through": 10,
          "value": 25000
        }
      ]
    },
    "targetCashValueOption": "SPECIFY_AMOUNT",
    "targetCashValueAtOption": "AGE",
    "targetCashValueAge": 10,
    "targetCashValueYear": 10,
    "targetCashValueAmount": 10000
  },
  "reports": {
    "internalRateOfReturnOn": true,
    "annualChargesOn": true,
    "annualChargesYears": 10,
    "monthlyChargesOn": true,
    "monthlyChargesYears": 10,
    "marketingPagesOn": true,
    "costDetailsReportOn": true,
    "inputSummaryOn": true
  }
}

Illustration Request for Term Life

Illustration Request for Term Life product

calculationTypestringrequired

Type of calculation. Only SINGLE_ILLUSTRATION triggers a PDF to be generated.

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTIONINITIAL_QUOTE

Example:QUICK_QUOTE

sourcestring

Source of the request

Example:ZINNIA

illustrationRequestDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2025-05-13

jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

coveragesarray[object]required

A benefit conferred to a group of one or more participants

Show Child Parameters
partiesAny Of
arrayrequiredunique-items

Must have at least one party representing the Insured participant

>= 1 items

Non-Insured Partyobject

Represents a party with a roleCode other than INSURED

Show Child Parameters
optionsobject

Fundamental Options schema. Some products may have product-specific Options.

Show Child Parameters
reportsobject
Show Child Parameters
Example
{
  "calculationType": "QUICK_QUOTE",
  "source": "ZINNIA",
  "illustrationRequestDate": "2025-05-13",
  "jurisdiction": "AK",
  "planCode": "EG123",
  "coverages": [
    {
      "coverageId": "BASE_COVERAGE",
      "riderYears": 10,
      "currentAmount": 1000,
      "participants": [
        {
          "issueAge": 30,
          "participantId": "2ad51ecf-9923-437f-a6f0-70968e464cdb",
          "underwritingClass": "ULTRANONTOBACCO",
          "subStandardRating": "TABLEA",
          "flatExtra": [
            {
              "type": "PERMANENT",
              "amount": 1000,
              "duration": 12,
              "durationType": "YEARS",
              "startDate": "2025-05-13"
            }
          ]
        }
      ]
    }
  ],
  "parties": [
    {
      "partyId": "95f5ece9-e40b-450b-ad39-daa217894e69",
      "partyTypeCode": "INDIVIDUAL",
      "gender": "MALE",
      "dateOfBirth": "1990-05-13",
      "firstName": "John",
      "middleName": "Frederick",
      "lastName": "Doe",
      "suffix": "Jr.",
      "address": {
        "addressLine1": "123 Charter Oak",
        "addressLine2": "Suite 456",
        "city": "Manchester",
        "state": "CT",
        "zipCode": "123456"
      },
      "email": "person@example.com",
      "phoneType": "HOME",
      "phone": "1238675309",
      "identification": {
        "identificationType": "PASSPORT",
        "identificationKey": "ECN",
        "identificationDescription": "ECN",
        "identificationValue": "ECN"
      },
      "roleCode": "OWNER"
    }
  ],
  "options": {
    "revisedIllustration": true,
    "solveFor": "PREMIUM",
    "fixedCostPeriod": 10,
    "paymentMode": "DAILY",
    "discountIndicator": "MULTIPRODUCT",
    "paymentMethod": "DTCC",
    "premiumDuration": 10,
    "premiumDurationOption": "YEARS",
    "faceAmount": {
      "frequency": "DAILY",
      "basis": "AGE",
      "sequence": [
        {
          "from": 1,
          "through": 10,
          "value": 250000
        }
      ]
    },
    "premium": {
      "frequency": "DAILY",
      "basis": "AGE",
      "sequence": [
        {
          "from": 1,
          "through": 10,
          "value": 25000
        }
      ]
    },
    "targetCashValueOption": "SPECIFY_AMOUNT",
    "targetCashValueAtOption": "AGE",
    "targetCashValueAge": 10,
    "targetCashValueYear": 10,
    "targetCashValueAmount": 10000
  },
  "reports": {
    "internalRateOfReturnOn": true,
    "annualChargesOn": true,
    "annualChargesYears": 10,
    "monthlyChargesOn": true,
    "monthlyChargesYears": 10,
    "marketingPagesOn": true,
    "costDetailsReportOn": true,
    "inputSummaryOn": true
  }
}

Illustration Request for IUL

Illustration Request for Indexed Universal Life product

calculationTypestringrequired

Type of calculation. Only SINGLE_ILLUSTRATION triggers a PDF to be generated.

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTIONINITIAL_QUOTE

Example:QUICK_QUOTE

sourcestring

Source of the request

Example:ZINNIA

illustrationRequestDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2025-05-13

jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

coveragesarray[object]required

A benefit conferred to a group of one or more participants

Show Child Parameters
partiesAny Of
arrayrequiredunique-items

Must have at least one party representing the Insured participant

>= 1 items

Non-Insured Partyobject

Represents a party with a roleCode other than INSURED

Show Child Parameters
optionsobject

Options for the illustration request.

Show Child Parameters
reportsobject
Show Child Parameters
conversionobject

Specifies what type of conversion is occurring

Show Child Parameters
lumpSumDepositsarray[object]

Additional one-time payments that take place at specified points in time

Show Child Parameters
fundAllocationsarray[object]required

Fund allocations

Show Child Parameters
distributionsobject

Distributions

Show Child Parameters
exchangesobject
Show Child Parameters
Example
{
  "calculationType": "QUICK_QUOTE",
  "source": "ZINNIA",
  "illustrationRequestDate": "2025-05-13",
  "jurisdiction": "AK",
  "planCode": "EG123",
  "coverages": [
    {
      "coverageId": "BASE_COVERAGE",
      "riderYears": 10,
      "currentAmount": 1000,
      "participants": [
        {
          "issueAge": 30,
          "participantId": "2ad51ecf-9923-437f-a6f0-70968e464cdb",
          "underwritingClass": "ULTRANONTOBACCO",
          "subStandardRating": "TABLEA",
          "flatExtra": [
            {
              "type": "PERMANENT",
              "amount": 1000,
              "duration": 12,
              "durationType": "YEARS",
              "startDate": "2025-05-13"
            }
          ]
        }
      ]
    }
  ],
  "parties": [
    {
      "partyId": "95f5ece9-e40b-450b-ad39-daa217894e69",
      "partyTypeCode": "INDIVIDUAL",
      "gender": "MALE",
      "dateOfBirth": "1990-05-13",
      "firstName": "John",
      "middleName": "Frederick",
      "lastName": "Doe",
      "suffix": "Jr.",
      "address": {
        "addressLine1": "123 Charter Oak",
        "addressLine2": "Suite 456",
        "city": "Manchester",
        "state": "CT",
        "zipCode": "123456"
      },
      "email": "person@example.com",
      "phoneType": "HOME",
      "phone": "1238675309",
      "identification": {
        "identificationType": "PASSPORT",
        "identificationKey": "ECN",
        "identificationDescription": "ECN",
        "identificationValue": "ECN"
      },
      "roleCode": "OWNER"
    }
  ],
  "options": {
    "doli": "GPT",
    "deathBenefitOption": {
      "frequency": "DAILY",
      "basis": "AGE",
      "sequence": [
        {
          "from": 1,
          "through": 10,
          "value": "LEVEL"
        }
      ]
    },
    "dumpInAmount": 5432.62,
    "juvenileReclassification": true,
    "preventModifiedEndowmentContract": true,
    "illustrationBasis": "CURRENT"
  },
  "reports": {
    "internalRateOfReturnOn": true,
    "annualChargesOn": true,
    "annualChargesYears": 10,
    "monthlyChargesOn": true,
    "monthlyChargesYears": 10,
    "marketingPagesOn": true,
    "costDetailsReportOn": true,
    "inputSummaryOn": true
  },
  "conversion": {
    "conversionType": "STANDARD",
    "isSourceMEC": true,
    "conversionCredit": 5000
  },
  "lumpSumDeposits": [
    {
      "amount": 100000,
      "duration": 65,
      "month": 12
    }
  ],
  "fundAllocations": [
    {
      "allocationPercent": 50,
      "fundId": "SPX",
      "illustratedRate": 0.3
    }
  ],
  "distributions": {
    "frequency": "DAILY",
    "sequence": [
      {
        "amountType": "AMOUNT",
        "requestedAmount": 10000,
        "funding": "LOAN",
        "from": {
          "offset": 1,
          "basis": "AGE"
        }
      }
    ],
    "loanInterestOption": "BORROW"
  },
  "exchanges": {
    "internal": {
      "amount": 5000,
      "basis": 5000,
      "isModifiedEndowmentContract": true,
      "carryoverLoan": 5000
    }
  }
}