Illustration-Generation
Coverage (v3)
objectA benefit conferred to a group of one or more participants
attributesobjectrequired
A collection of uniquely named variables, must be camel-cased.
Show Child Parameters
participantsarray[object]requiredunique-items
An entity with a stake in a policy
Show Child Parameters
feesarray[object]required
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
Example
Coverage-Collection (v3)
arrayA collection of benefits
attributesobjectrequired
A collection of uniquely named variables, must be camel-cased.
Show Child Parameters
participantsarray[object]requiredunique-items
An entity with a stake in a policy
Show Child Parameters
feesarray[object]required
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
Party
objectA unique entity
attributesobjectrequired
A collection of uniquely named variables, must be camel-cased.
Show Child Parameters
personobjectrequired
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
organizationobjectrequired
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
trustobjectrequired
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
Example
Parties
arrayAn unkeyed collection of unique Party objects
attributesobjectrequired
A collection of uniquely named variables, must be camel-cased.
Show Child Parameters
personobjectrequired
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
organizationobjectrequired
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
trustobjectrequired
A simple object that only contains a collection of unique attributes and no further structure.
Show Child Parameters
Illustration Input Party
A party supplied on an illustration request, either the Insured or a non-insured party
Any OfpartyIdstring(uuid)required
Party id
Example:95f5ece9-e40b-450b-ad39-daa217894e69
partyTypeCodestringrequired
Party type
Allowed values:INDIVIDUALORGANIZATIONTRUST
Example:INDIVIDUAL
genderstring
Gender
Allowed values:MALEFEMALEUNISEXOTHER
Example:MALE
dateOfBirthstring(date)
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:1990-05-13
firstNamestring
First Name
Example:John
middleNamestring
Middle Name or Initial
Example:Frederick
lastNamestring
Last name
Example:Doe
suffixstring
Name Suffix
Example:Jr.
addressobject
Address
Show Child Parameters
emailstring(email)
Example:person@example.com
phoneTypestring
Phone type
Allowed values:MOBILEHOMEBUSINESSCLAIMCENTERCUSTOMERSERVICECORPORATEOFFICEFAXUNKNOWNOTHER
Example:HOME
phonestring
Phone
Example:1238675309
identificationobject
Identification
Show Child Parameters
roleCodestringrequired
The role of a given party
Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNER
Example:OWNER
Example