ExternalIllustrationPatch
objectIllustration Source
Allowed values:EXTERNAL
Default:EXTERNAL
Example:EXTERNAL
Unique identifier for the illustration
Example:Q12345
Show Child Parameters
Show Child Parameters
illustrationDetails
objectAssociated lead identifier
Example:L12345
Risk classification for the illustration
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
Contact email for the illustration
Example:tKU3e@example.com
Abbreviated names for states
Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY
Example:CA
Face amount of the policy
>= 0
Example:100
Premium amount
>= 0
Example:100
Term of payment
Example:MONTHLY
Frequency of premium payments
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT
Example:MONTHLY
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:1990-01-01
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2022-01-01
Gender of the insured
Allowed values:MALEFEMALEOTHER
Example:MALE
Smoking status
General health status
Example:Good
Method of underwriting
Allowed values:FULL_UNDERWRITINGSIMPLIFIED_ISSUEGUARANTEED_ISSUE
Example:SIMPLIFIED_ISSUE
Age at policy issuance
Example:25
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2022-01-01
Cash value of the policy
Example:1000
illustration generation success indicator
Example:true
Annual income of the insured
>= 0
Example:10000
Annual policy management fee
>= 0
Example:100
Additional payment amount if any
>= 0
Example:100
Version of pricing engine used
Example:1.0
Version of matching algorithm used
Example:1.0
Percentage match for the illustration
>= 0<= 100
Example:90
Average monthly cost of insurance
>= 0
Example:100
First month’s cost of insurance
>= 0
Example:100
Administrative fee
>= 0
Example:10
First month’s savings
Show Child Parameters
Show Child Parameters
illustrationDetailsPatch
objectAssociated lead identifier
Example:L12345
Risk classification for the quote
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
Contact email for the quote
Example:tKU3e@example.com
Abbreviated names for states
Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY
Example:CA
Face amount of the policy
>= 0
Example:100
Premium amount
>= 0
Example:100
Term of payment
Example:MONTHLY
Frequency of premium payments
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT
Example:MONTHLY
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:1990-01-01
Date (with pattern “yyyy-mm-dd”)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Example:2022-01-01
Gender of the insured
Allowed values:MALEFEMALEOTHER
Example:MALE
Smoking status
General health status
Example:Good
Method of underwriting
Allowed values:FULL_UNDERWRITINGSIMPLIFIED_ISSUEGUARANTEED_ISSUE
Example:SIMPLIFIED_ISSUE
Age at policy issuance
Example:25
Date and time in ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$
Example:2022-01-01T00:00:00.000Z
Cash value of the policy
Example:1000
Quote generation success indicator
Example:true
Annual income of the insured
>= 0
Example:10000
Annual policy management fee
>= 0
Example:100
Additional payment amount if any
>= 0
Example:100
Version of pricing engine used
Example:1.0
Version of matching algorithm used
Example:1.0
Percentage match for the quote
>= 0<= 100
Example:90
Average monthly cost of insurance
>= 0
Example:100
First month’s cost of insurance
>= 0
Example:100
Administrative fee
>= 0
Example:10
First month’s savings
Show Child Parameters
Show Child Parameters
Document
objectExternal document identifier
Example:1234567890
Allowed values:NB_APPLICATIONCOST_DISCLOSURENON_CONTRACTUALAGENT_REPORTACCELERATED_BENEFIT_RIDERSURRENDER_COMPARISIONCONSENT_PAPERLESSTERMS_OF_USETERMS_CONDITIONSCHARITY_ELECTION_FORMSAUTHORIZATION_FORMSHIPPAHIV_CONSENT_FORM_ALL_STATEAMENDMENTDISCLOSURESNB_STATE_REPLACEMENT_NOTICETRUSTEE_STATEMENTTERMS_OF_USENOTICE_AND_CONSENTPRIVACY_POLICYGLBA_PRIVACY_NOTICEFCRAMIB_PRE_NOTICEID_VERIFICATION_NOTICEHIPAAACCELERATED_BENEFIT_RIDERBUYER_GUIDEILLUSTRATIONSUITABILITYAPPLICATIONSIGNED_APPLICATIONREPLACEMENTS_ACKNOWLEDGEMENT1035_EXCHANGE_SURRENDEREVIDENCE_DOCUMENTAMENDMENTELECTRONIC_FUNDS_TRANSFERSUPPLEMENTAL_APPLICATIONCONFORMING_ILLUSTRATIONSIGNED_ILLUSTRATIONOVERFLOW_ADDITIONAL_INFORMATION
Example:TERMS_OF_USE
Example:APPLICATION
DocumentPatch
objectExternal document identifier
Example:1234567890
Allowed values:NB_APPLICATIONCOST_DISCLOSURENON_CONTRACTUALAGENT_REPORTACCELERATED_BENEFIT_RIDERSURRENDER_COMPARISIONCONSENT_PAPERLESSTERMS_OF_USETERMS_CONDITIONSCHARITY_ELECTION_FORMSAUTHORIZATION_FORMSHIPPAHIV_CONSENT_FORM_ALL_STATEAMENDMENTDISCLOSURESNB_STATE_REPLACEMENT_NOTICETRUSTEE_STATEMENTTERMS_OF_USENOTICE_AND_CONSENTPRIVACY_POLICYGLBA_PRIVACY_NOTICEFCRAMIB_PRE_NOTICEID_VERIFICATION_NOTICEHIPAAACCELERATED_BENEFIT_RIDERBUYER_GUIDEILLUSTRATIONSUITABILITYAPPLICATIONSIGNED_APPLICATIONREPLACEMENTS_ACKNOWLEDGEMENT1035_EXCHANGE_SURRENDEREVIDENCE_DOCUMENTAMENDMENTELECTRONIC_FUNDS_TRANSFERSUPPLEMENTAL_APPLICATIONCONFORMING_ILLUSTRATIONSIGNED_ILLUSTRATIONOVERFLOW_ADDITIONAL_INFORMATION
Example:TERMS_OF_USE
Example:APPLICATION