Case Integration API

Introduction

This page describes the Scalepoint Unified Case Integration API. This API can be used to integrate case information in Scalepoint CORE, HUB and ClaimShop

Overview

The process of case integration can be divided into two steps:

• Authentication
• Case creation

Authentication

You need an access token in order to send data to the Integration Endpoint. This access token can be obtained from the Authentication Endpoint (scope: case_integration). Please refer to the documentation about details of authentication process.

Case Integration API endpoint

The integration endpoint is in the following format:

https://www.scalepoint.com/api/integration/<country>/<tenant>/<version>/case

The actual format of this will depend on the insurance company, the country in which it operates and the version of the API. Assuming the following:

• Country: Denmark
• Tenant: ABC Insurance
• Other brands: Budget Insurance

The endpoint could look something like this:

https://www.scalepoint.com/api/integration/dk/abcinsurance/v1/case

For testing purposes, you will be given access to a project server and the hostname-part of the endpoint would change accordingly:

https://<hostname>/api/integration/dk/abcinsurance/v1/case

Please discuss with your account manager, which project server you have been assigned in order to determine the actual endpoint.

Integration

Create Case Request

Create case request contains of two different parts:

• Create case request data;
• Authorization header.

Create case request data presented in JSON format is sent in the request body. This is the example of the simplest create case request data:

{
   "tenant": "abcinsurance",
   "company": "budgetinsurance",
   "country": "dk",
   "caseType": "buildingClaim",
   "caseNumber": "9871234-01",
   "policy": {
      "number": "4405.09228"
   }
}

Actual request can contain much more data and will be described later. * Please refer to the JSON Schema

Authorization header has name 'Authorization'. It has value built from access_token in following format:

Bearer access_token

Note the important space character between 'Bearer' and access_token value. Ensure that you send correct 'Content-Type' header. It should be application/json;charset=utf-8

Create Case Response

Create Case Response contains data in JSON format. Response contains following fields:

• success - true if request completed, false otherwise
• token - created case token
• url - absolute link to case in case handling system. When opened in browser, url will redirect either to a claim creation wizard if the case creation wasn't completed before, or will open an existing case view if the case creation was completed before
• warnings and errors - can hold some additional data about case create request processing

Successful response example

{
   "success": true,
   "token": "b.06317562-7f4a-4c7e-9ee4-eae06e590c37",
   "url": "https://www.scalepoint.com/api/integration/dk/abcinsurance/v1/case/b.06317562-7f4a-4c7e-9ee4-eae06e590c37",
   "warnings": [{
      "type": "actionRequired",
      "message": "We could not automatically find claim handler to assign. Please open claim wizard to resolve the issue.",
      "isAutoCreationForbidden": false
   }]
}

Error response example

{
   "success": false,
   "errors": [{
      "type": "invalidFormat",
      "message": "Invalid JSON."
   }]
}

Errors and warnings

Both errors and warnings are arrays of objects with type and message properties. Types are well known and defined below.

The main difference between the two is in severity. If application can continue handling the request with some minor problems, it will report them as warnings. If processing has to stop, errors will be provided.

isAutoCreationForbidden property in warnigs tells us, can a claim be automatically created with this warning present.

Appendix A – Data elements description

Root

Integration options

Questionaire

Policy

Customer

Contacts

For the moment only HUB Property and Subrogation support contacts. The details of the contact are similar to those of "customer" with some differences:

Loss

Loss vehicle

* Only used in legacy motor referral sustem HUB Motor. The newer claim system uses dynamic fields for setting the car loss properties. See Case section

Loss building

Loss health

Risk Assessment

Extra modifiers

The extra modifiers can be used to enhance a case with additional details. It takes the following format:

"extraModifiers": [{
   "type": "<modifierCode>",
   "value": "<modifierValue>"
}]

Examples:

"extraModifiers": [{
   "type": "propertyCode",
   "value": "1102"
}]

"extraModifiers": [{
   "type": "inspectionType",
   "value": "field"
}]

"extraModifiers": [{
   "type": "typeOfHiddenPlacesPipes",
   "value": "FloorHeating"
},{
   "type": "LeakType",
   "value": "OilLeak"
}]

"extraModifiers": [{
   "type": "postItemizationCompletedUrl",
   "value": "http://www.abcinsurance.com/thankyou.aspx?userid=DPMWI29us9IcUvGb"
}]

"extraModifiers": [
  {
    "type": "sourceOfFNOL",
    "value": "claimant"
  }
]

AssignTo

The assignTo section can be used to assign people, pools and companies to various roles in HUB Motor, HUB Property and ClaimShop applications. Multiple roles can be assigned. The format is as follows:

"assignTo": [{
    "role": "caseOwner",
    "email": "user@abcinsurance.dk"
}
 ,{
   "services": [{
        "type": "vehicleRepair"
   }],
   "id": "12345-3445-AD45-3445-AD45"
}]

services []

DamageAddress

The damageAddress section can be used to set custom address for generic type (Insurance) claims. When newly added damage address is provided we use it to set damage address value on claim. The format is as follows:

"damageAddress": {
    "street1": "streetName",
    "street2": "",
    "postalCode": "1234",
    "city": "City Name",
    "state": "",
    "country": "dk"
  }

CustomService

The customService section can be used to request custom service with assigned External or Internal Service Partner. Service request can be blocked by enabling the "Custom service request default value". The format is as follows:

"customService": {
    "id": "",
    "title": "Test",
    "asigneeType": "External",
    "email": "testservicepartner@example.com"
  }

Case

The case section can be used to pass an additional, non-generic data for different case types. It also can be used to map dynamic fields automatically.

Appendix B – Damage Types

HUB Motor Damage types

HUB Property Damage types and subtypes

Appendix C – Vehicle damage areas

Appendix D – Building sectors

Appendix D.1 – Health sectors

Appendix E – External references

Country codes

• https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Date/time format

• https://en.wikipedia.org/wiki/ISO_8601
• https://tools.ietf.org/html/rfc3339#section-5.6

Appendix F - Descriptive content format

Allows providing additional unstructured data that can be displayed on UI. Is not intended to be edited in application.

{
   "title": "<title>",
   "properties": {
     "xxx": {
       "title": "<title>",
       "value": <value>,
       "formattedValue": "<formatted value>"
     },
     "yyy": {
       "title": "<title>",
       "properties": { ... }
     }
     ...
   }
}

{
   "title": "<title>",
   "properties": [
     {
       "title": "<title>",
       "value": <value>,
       "formattedValue": "<formatted value>"
     },
     {
       "title": "<title>",
       "properties": { ... }
     },
     ...
   ]
}

Examples:

{
  "properties": {
    "deductible": {
      "title": "Deductible",
      "value": 5000.57,
      "formattedValue": "5,000.57 kr."
    }
  }
}

{
  "title": "Deductible section",
  "properties": {
    "deductibleHistory": {
      "title": "Deductible history",
      "value": "No"
    },
    "selfRisk": {
      "title": "Self risk",
      "properties": {
        "deductible": {
          "title": "Deductible",
          "value": 5000.57,
          "formattedValue": "5,000.57 kr."
        }
      }
    }
  }
}

Appendix G - AssignTo with service provider and case owner roles described

This set of options can be used to fully create the case (in contrast to having a case worker open the case wizard).

"integrationOptions" : {
    "autoCompleteCreation" : true
}
"assignTo" : [{
        "services" : [{
                "type" : "vehicleRepair",
            }
        ],
        "id" : "12345-3445-AD45-3445-AD45"
    }, {
        "role" : "caseOwner",
        "email" : "john@doe.com"
    }
]

Appendix H - Loss(damage) coverages

Appendix I - AssignTo with service partner and additional referral options (building claim example)

Here is an example how to specify service referral options for building claim

"assignTo" : [
    {
      "role": "networkCraftsman",
      "autoAssign": true,
      "services": [
          {
              "type": "buildingRepair",
              "allowToStartRepairImmediately": true,
              "repairAllowanceLimit": 11111
          },
          {
              "type": "buildingInspection"
          }
       ]
    }
]

"extraModifiers": [{
   "type": "postItemizationCompletedUrl",
   "value": "http://www.abcinsurance.com/thankyou.aspx?userid=DPMWI29us9IcUvGb"
}]

Appendix J - Case Create request payload examples

• Building case create example
• Content case create example