API Documentation

Welcome to the Cytora API documentation. You'll find comprehensive guides to explain what Cytora can provide and developer documentation how to integrate Cytora APIs in your processes. And if there is anything missing or confusing, feel free to raise a question in the discussion. Again welcome! Hope you enjoy it!

Duck Creek OnDemand

Accelerates the quoting process by enabling Property API

Since January 28th 2020, the Cytora solution is available on the Duck Creek Content Exchange. The partnership allows Duck Creek customers to use Cytora Property API in the Duck Creek OnDemand Policy module to accelerate the quoting process by enabling a bind, decline or refer workflow.

Overview

Duck Creek Technologies is one of the leading global Property & Casualty technology platforms. The OnDemand offering allows large insurance companies to create, support and innovate insurance products to their distribution channels on a Software as a Service model.

Within the OnDemand solution, the key modules are:

  • Policy: receive quote requests and deliver policies for existing and new insurance products
  • Rating: price quotes across products and geographies
  • Billing: trigger and review all billings based on the agreed policies
  • Claims: decide and execute on claims during the policy life cycle

Cytora Solution

Currently, the Cytora Solution can only be enabled in the policy module of Duck Creek OnDemand

The Cytora Solution allows additional information from the Property API to the quote request in Duck Creek OnDemand. The additional information can be attributes about the property itself like Property usage, Building heights or Fire risk and about area statistics like Crimes. All attributes from the Data menu are available when reviewing a property for an insurance product.

Example of Cytora Property API information as part of a Duck Creek policy

Example of Cytora Property API information as part of a Duck Creek policy

Enable Cytora Solution in Duck Creek OnDemand Policy module

The integration instructions and files are available for Duck Creek customers as a package in the Duck Creek Content Exchange.
To configure the property information, the fields from the Integration ManuScript need to be added to the LOB ManuScript.

Additional Cytora Integration fields to be added to LOB ManuScript

Additional Cytora Integration fields to be added to LOB ManuScript

Or a change to the RAW XML can be made to configure the Cytora Integration to be part of the Integration ManuScript.

<object id="Integration" path="integration">
  <minOccurs value="1" />
  <maxOccurs value="1" />
  <object id="Cytora" path="cytora">
    <minOccurs value="1" />
    <maxOccurs value="1" />
    <public id="Cytora.ManuscriptId" path="ManuscriptId" type="string">
      <definition>
        <caption value="Manuscript Id" />
      </definition>
      <rules>
        <value>
          <request verb="ManuScriptBroker.listRq" get="items/item/@id">
            <responsePath value="" />
            <onFailure value="" />
            <modifySession value="" />
            <usesSession value="" />
            <default value="" />
            <nameValues>
              <nameValue value="" name="keys" dataType="element">
                <nameValue value="" name="key" dataType="element">
                  <nameValue value="=" name="operator" dataType="attribute" />
                  <nameValue value="versionID" name="name" dataType="attribute" />
                  <nameValue idref="Cytora.IntegrationManuscriptID" name="value" dataType="attribute" />
                </nameValue>
              </nameValue>
              <nameValue value="" name="showHidden" dataType="attribute" />
            </nameValues>
          </request>
        </value>
        <default value="" />
      </rules>
    </public>
    <public id="Cytora.CytoraInstalled" path="CytoraInstalled" type="boolean">
      <definition>
        <caption value="Is Cytora Installed" />
      </definition>
      <rules>
        <value>
          <comparison compare="ne">
            <operand idref="Cytora.ManuscriptId" type="string" />
            <operand type="string" value="Cytora_UWAssesment_Integration_1_0_0_0" />
          </comparison>
        </value>
        <affects>
          <reference idref="Cytora.CytoraNotInstalled" effect="postEffect" />
        </affects>
      </rules>
    </public>
    <public id="Cytora.UseCytora" type="boolean" comment="" path="UseCytora" alwaysRun="1">
      <definition>
        <caption type="string" value="Use Cytora" />
      </definition>
      <rules>
        <default idref="False" />
      </rules>
    </public>
    <public id="Cytora.CytoraNotInstalled" path="CytoraNotInstalled" type="boolean">
      <definition>
        <caption value="Cytora Not Installed" />
      </definition>
      <rules>
        <value>
          <comparison compare="eq">
            <operand idref="Cytora.CytoraInstalled" type="boolean" />
            <operand idref="False" type="int" />
          </comparison>
        </value>
      </rules>
    </public>
    <public id="Cytora.WarningCount" path="WarningCount" type="int">
      <definition>
        <caption value="Warning Flag" />
      </definition>
    </public>
    <public id="Cytora.IntegrationManuscriptID" type="string" comment="" path="IntegrationManuscriptID">
      <definition>
        <caption type="string" value="Integration Manuscript ID" />
      </definition>
      <rules>
        <value value="Cytora_UWAssesment_Integration_1_0_0_0" />
      </rules>
    </public>
  </object>
</object>

The next step is to enable sending the address information from the premises of the policy to Cytora.
Select and add the address fields in the Cytora_UWAssesment_Integration_1_0_0_0 Integration Manuscript such as .Line1, .Line2, .Postcode.

Example fields from the address input that is captured on the policy

Example fields from the address input that is captured on the policy

The second step is to configure what to do when having reviewed the property information and closing the assessment.

Set the Page, Page Set and ManuScript ID to return to after the assessment

Set the Page, Page Set and ManuScript ID to return to after the assessment

The last step is to configure the connection to Cytora using:

Both configuration settings can be found in the Cytora_GetAssessment_Request.xslt that is part of the [Policy Install Directory]\Transform\Integration folder.

<!-- Cytora API URL -->
<xsl:attribute name="url">
 <xsl:value-of select="'https://api.cytora.com/v1/properties/resolve'"/>
</xsl:attribute>
<!-- Cytora API headers -->
<headers>
 <header name="Authorization" value="Basic {{Base64 encoded API credentials}}" />
 <header name="Content-Type" value="application/json" />
</headers>
<!-- Cytora Property API attributes -->
<parameter name="attributes"
value="{{examples could be crimesCountBurglary,crimesCountRobbery,crimesCountDrugs,crimesCountCriminalDama
geAndArson,crimesCountVehicleCrime,fireRiskScore}}"/>
<!-- Give custom names to Cytora Property API attributes -->
<xsl:when test="name(.)='crimesCountBurglary'">Burglary</xsl:when>
<xsl:when test="name(.)='crimesCountCriminalDamageAndArson'">Criminal Damage And Arson</xsl:when>
<xsl:when test="name(.)='crimesCountDrugs'">Drug</xsl:when>
<xsl:when test="name(.)='crimesCountVehicleCrime'">Vehicle</xsl:when>

The additional required header Content-Type that specifies that the Cytora API response is in JSON format, should already be part of the Cytora_GetAssessment_Request.xslt file.

Configure Cytora Property in Duck Creek OnDemand Policy module

What to do with the property information for each premise of the policy or quote can range from just information to automated underwriting workflows.

The setup via the enabled ManuScript or the XML file allows triggering the integration between Duck Creek and Cytora as well as the placeholders for the UI changes in Duck Creek.

User Interface changes

The power of the Cytora API is to embedded in many different applications. The API is only delivering the information, the Interface that the user works is the Duck Creek OnDemand application. Therefore, the User Interface changes only apply to Duck Creek.

Changing the workflow when reviewing premises by incorporating additional information can have a high impact on the daily work of all the agents. To make the change as positive as possible, the buttons, pop-ups, and text that agents see in Duck Creek can be configured to match preferences.

This can be done by adding the UI features in the Integration ManuScript:

Adding custom UI sections in the Duck Creek UI when reviewing premises

Adding custom UI sections in the Duck Creek UI when reviewing premises

The custom set up of text, buttons, and dimensions of the different elements can be configured in the RAW XML.

<!-- the text that indicates the checkbox of initiating the Cytora Integration -->
<reference idref="Cytora.UseCytora" onBlur="1" compute="1" caption="Use Cytora Underwriting Assessment" index="E">
  <nameValues />
</reference>
<section direction="across" captionPosition="before" showCaption="repeat" cc="GrayPanel" validRef="Cytora.UseCytora" index="F">
  <nameValues>
    <!-- the text for the caption of the Cytora assessments -->
    <nameValue value="Cytora UW Assessment" name="toggleCaption" />
    <!-- the text for the caption of the Cytora assessments -->
    <nameValue value="Cytora Assessment" name="panelHeader" />
  </nameValues>
  <!-- change the name of the button to view previous assessments -->
  <action command="custom" caption="View Assessments" pageRef="Cytora" topic="Cytora" index="10">
    <nameValues>
      <nameValue idref="Cytora.ManuscriptId" name="manuscript" />
      <nameValue value="1" name="popUp" />
      <!-- change the width in pixels of the popup when viewing the assessment -->
      <nameValue value="700" name="popUpWidth" />
      <!-- change the height in pixels of the popup when viewing the assessment -->
      <nameValue value="500" name="popUpHeight" />
    </nameValues>
  </action>
  <!-- change the name of the button to start a new assessments -->
  <action command="custom" caption="Get New Assessments" pageRef="Cytora" topic="Cytora" index="11">
    <nameValues>
      <nameValue idref="Cytora.ManuscriptId" name="manuscript" />
      <nameValue value="1" name="popUp" />
      <!-- change the width in pixels of the popup when viewing the assessment -->
      <nameValue value="700" name="popUpWidth" />
      <!-- change the height in pixels of the popup when viewing the assessment -->
      <nameValue value="500" name="popUpHeight" />
    </nameValues>
    <request verb="ManuScript.getValueRq">
      <nameValues>
        <nameValue value="Cytora_UWAssesment_Integration_1_0_0_0" name="manuscript" dataType="attribute" />
        <nameValue value="" name="context" dataType="attribute" />
        <nameValue value="AssessmentRequest.GetAssessmentRq" name="field" dataType="attribute" />
        <nameValue value="" name="debugInfo" dataType="attribute" />
        <nameValue value="" name="fullDetail" dataType="attribute" />
        <nameValue value="" name="messages" dataType="attribute" />
        <nameValue value="" name="worksheetData" dataType="attribute" />
        <nameValue value="" name="worksheetValue" dataType="attribute" />
        <nameValue value="" name="wsShowParenthesis" dataType="attribute" />
        <nameValue value="" name="wsShowNonAltering" dataType="attribute" />
        <nameValue value="" name="wsSuppressRound" dataType="attribute" />
        <nameValue value="" name="wsKeyNodes" dataType="attribute" />
        <nameValue value="" name="wsKeyNodes" dataType="attribute" />
        <nameValue value="" name="wsInclude" dataType="attribute" />
        <nameValue value="" name="wsDepth" dataType="attribute" />
        <nameValue value="" name="wsDebug" dataType="attribute" />
        <nameValue value="" name="wsShowAllMatches" dataType="attribute" />
      </nameValues>
    </request>
  </action>
</section>

The changes that can be made to the name, text, and dimensions can be seen in the Duck Creek UI.

Example of default User Interface changes when configuring Cytora Solution

Example of default User Interface changes when configuring Cytora Solution

As a last optional step in the underwriting workflow, rules can be configured that allow the agent to approve/reject the quote. This means that certain property information from Cytora can automate the policy process and reduce underwriting time while maintaining your compliance.

Automated policy workflow

Cytora highly recommends using the property information to automate an accept, decline or refer quotes and policies. The different attributes from the Property API lend themselves for a full review and can save precious underwriting time.

Changing the workflow for the different roles within the underwriting team is done by modifying the .isBindableAgent, isBindableAssistant and/or isBindableManager fields in each LOB.

Select the user role you want to change the binding access for

Select the user role you want to change the binding access for

For each user role, the rules as to when this user role can bind or not are defined.

The rules, conditions and message based upon Cytora property information

The rules, conditions and message based upon Cytora property information

Another way to configure the rules is to change the RAW XML.

<!-- select the isBindable role like isBindableAgent or isBindableAssistant -->
<private id="ReferralRules.IsBindableAgent" caption="Agent Can Bind" type="boolean" override="1">
  <value idref="True" />
  <misc>
    <!-- set up condition -->
    <if>
      <condition>
        <comparison compare="and">
          <comparison compare="eq">
            <operand idref="PolicyInput.ReviewAtRenewal" type="boolean" />
            <operand idref="True" type="int" />
          </comparison>
          <operand idref="PolicyPrivate.IsCurrentTransactionRenew" type="boolean" />
        </comparison>
      </condition>
      <!-- define what will happen if condition is checked -->
      <then idref="False" message="ReferralRules.IsBindableAgentMsg1" />
    </if>
    <!-- set up condition -->
    <if>
      <condition>
        <comparison compare="and">
          <comparison compare="gt">
            <!-- select Cytora fields and values -->
            <operand idref="Cytora.WarningCount" type="int" />
            <operand type="string" value="0" />
          </comparison>
          <comparison compare="eq">
            <operand idref="Cytora.UseCytora" type="boolean" />
            <operand idref="True" type="int" />
          </comparison>
        </comparison>
      </condition>
      <!-- define what will happen if condition is checked -->
      <then idref="False" message="ReferralRules.IsBindableAgentMsg2" />
    </if>
  </misc>
</private>

The combination of the changes to the UI and the rules that apply to the user allows the Duck Creek user to automate the assessment of each premise.

Test Cytora Solution in Duck Creek OnDemand Policy module

After enabling the integration between Duck Creek and Cytora Property API and configuring the UI and rules, tests allow seeing the end result.
If the Cytora_UWAssesment_Integration_1_0_0_0 Integration Manuscript is installed, you will be able to check and uncheck the Cytora Assessment on the premises page.

Checking the Assessment will show the buttons to view previous assessments and/or start a new assessment

Checking the Assessment will show the buttons to view previous assessments and/or start a new assessment

Depended on configuring the rules and warning messages, the policy overview page will now have a warning message if certain rules have been violated.

Example warning message due to a rule violation related to the property information

Example warning message due to a rule violation related to the property information

Use Cytora Solution in Duck Creek OnDemand Policy module

After successful tests, the Cytora assessment can be used in the Duck Creek OnDemand policy module to enhance policy workflows. Underwriters can perform everyday reviews of quotes with less time and have more information to make a better decision. The Cytora solution also allows automating certain parts of the underwriting workflow to further speed up the underwriting processes.

Want to get started?

Please reach out to your Duck Creek contact person or contact Cytora

Updated 2 months ago


Duck Creek OnDemand


Accelerates the quoting process by enabling Property API

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.