---
title: "Case Integration API"
section: 5
order: 1
type: "doc"
openApiPath: "integration.json"
---

<!-- https://confluence.scalepoint.com/display/INTAPI/External+-+Scalepoint+Case+Integration+API -->
<!-- https://confluence.scalepoint.com/display/Itemization/Loss+data+API -->

# 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

![Websequence diagram of case integration](caseintegration_websequence.png)

## 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](/authentication) 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:

```json

{
   "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](/schemas/CreateGenericCaseRequest.schema.json)

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

```json
{
   "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

```json
{
   "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.

| Type | Description | Example |
| ------------------ |:------------------------------------------------------------------------|:-----------------------------------------------------------------|
| unsupportedValue | Can be either a warning or an error depending on the severity| "serviceLevel" could not be mapped |
| invalidFormat | Payload is broken | Request body is malformed or JSON is invalid according to schema |
| applicationError | Should be used with HTTP status code 500 whenever possible | Database connection failed |
| actionRequired     | Used for warnings when automation failed and user attention is required | Claim handler could not be mapped |
| unauthorizedRequest| Used with 401 Unauthorized  | No valid bearer token or scope is not allowed |
| invalidTenant      | Used with 403 Forbidden  | Tenant doesn't exist in the target system |


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

## Appendix A – Data elements description

### Root

<table>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>tenant</td>
<td>The tenant will be a value given to the company and will normally be the same as the company name. <br /> This isn't used to specify a relationship between a claim and a company, but rather to distinguish one company from another.</td>
<td>Yes</td>
</tr>
<tr>
<td>company</td>
<td>One or more company values will be assigned by Scalepoint to support your company/brands. <br /> For example if company is "<span style="color: rgb(91,155,213);"><em>ABC insurance</em></span>" they may be assigned the company key: "<span style="color: rgb(91,155,213);"><em>abcinsurance</em></span>" to indicate this company. <br /> If "<span style="color: rgb(91,155,213);"><em>ABC insurance</em></span>" also have another brand: "<span style="color: rgb(91,155,213);"><em>Budget Insurance</em></span>", this might be assigned the company key: "<span style="color: rgb(91,155,213);"><em>budget</em></span>" or "<span style="color: rgb(91,155,213);"><em>budgetinsurance</em></span>"</td>
<td>No</td>
</tr>
<tr>
<td>country</td>
<td>Since a company may be operating in several countries, using the same brand, we need the country value to distinguish. <br /> For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. <br /> For example, to specify Denmark, one would use "<span style="color: rgb(91,155,213);"><em>dk</em></span>".</td><td>Yes</td>
</tr>
<tr><td>caseType</td><td><p>The caseType determines the kind of case you are integrations. Allowed values are: "<span style="color: rgb(91,155,213);"><em>buildingClaim</em></span>", " <span style="color: rgb(91,155,213);"><em>buildingRiskAssessment</em></span>", "<span style="color: rgb(91,155,213);"><em>contentClaim</em></span>", <span>"</span><span style="color: rgb(91,155,213);"><em>contentItemization</em></span><span>", </span>"<span style="color: rgb(91,155,213);"><em>motorClaim</em></span>", "<span style="color: rgb(91,155,213);"><em>privateMedicalInsuranceClaim</em></span>" and "<span style="color: rgb(153,204,255);"><em>insuranceClaim</em></span>"</p>
<p>"MotorClaim" value is used for Scalepoint legacy motor referral case system, HUB  Motor. For the current integrations the motor claims should be integrated with CaseType "InsuranceClaim" and the relevant motor product. The motor product can be specified as subCaseType or "policy.productAlias".</p>
</td>
<td>Yes</td>
</tr>
<tr><td>subCaseType</td><td>The subCaseType. If the caseType is InsuranceClaim, the subCaseType can contain the value of product in format "{tenant}.product.motor".</td>
<td>Yes</td>
</tr>
<tr>
<td>caseNumber</td>
<td>The caseNumber is the identifier for the case. This is what Scalepoint will use to determine if a case that is being integrated, already exists or needs to be created. <br /> The combination of: tenant+company+country+caseType+caseNumber must be unique.If any one of these differ, it will be a new case.</td>
<td>Yes</td>
</tr>
<tr>
<td>language</td>
<td><span style="color: rgb(0,0,0);">Standard country-language code comprised of two arguments separated by a dash. </span><span style="color: rgb(0,0,0);"><span style="color: rgb(0,0,0);">The first argument is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. </span></span><span style="color: rgb(0,0,0);"><span style="color: rgb(0,0,0);"><span style="color: rgb(0,0,0);">The second argument to both constructors is a valid ISO Country Code. </span></span></span><span style="color: rgb(0,0,0);">These codes are the upper-case two-letter codes as defined by ISO-3166.</span><span style="color: rgb(0,0,0);">For example fr-CA is French Canadian.</span></td>
<td>No</td>
</tr>
<tr>
<td>externalReference</td><td>In order to allow for easier integration with other Scalepoint API's (foe example notifications or payment information), it is possible to specify an external reference for a case. <br /> Such an external reference should be unique to the specified case, but Scalepoint will not try to determine if it is actually unique or use this in any other way. <br /> It is a key that we store, which can then later be used as reference.</td>
<td>No <br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td></tr><tr><td><span style="color: rgb(0,0,0);">itemizationCaseReference</span></td><td>Unique Identifier (<span style="color: rgb(91,155,213);"><em><span>externalReference </span></em></span><span>or content itemization identifier assigned by Scalepoint</span>) by which itemization case would be linked together with the content claim as it is created.</td>
<td><span>No </span><br /><span></span><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>allowAutoClose</td>
<td>True if claim is allowed to be auto closed, basing on Audit Rule Engine result.</td>
<td></td></tr>
<tr>
<td>checkForFraud</td>
<td>True if check for Fraud should be performed for the current case</td>
<td>No <br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>relatedCaseNumbers</td>
<td>If other cases are related to the case, being integrated, a list of caseNumbers can be specified to indicate the relationship.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td>isUrgent</td><td>This parameter can be used to indicate if a case is urgent.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX</span><br /> <span style="color: rgb(237,125,49);">optional</span></td></tr>
<tr>
<td>firstNotificationDate</td>
<td>This is used to indicate the first time, when the case was notified (e.g. by a claimant using a self-service registration service). <br /> Date/time format should follow ISO-8601</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional<br></span></td>
</tr>
<tr>
<td>accidentDate</td>
<td>This is used to indicate the date (and optionally time) when the accident/loss occurred. <br /> Date/time format should follow ISO-8601</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor, HUB  Property, ClaimShop, ECX</span><br /><span style="color: rgb(237,125,49);">HUB Health (Date of first symptom)</span><br /><span style="color: rgb(237,125,49);">Yes for subrogation</span></td>
</tr>
<tr>
<td>sourceSystem</td>
<td>Name of the integration request system of origin. Used for analysis purposes.</td>
<td>No<br />
  <span style="color: rgb(237,125,49);">HUB  Property optional</span>
  <span style="color: rgb(237,125,49);">ClaimShop optional</span>
</td>
</tr>
<tr>
<td>sourceOfCreation</td><td>Describes how the case was submitted to the Insurance Company. Allowed values are: "Phone", "Written", "Internet", "Email", "EDI", "Forsi", "ExternalFNOL" and "Other". "InternetAutomatic" - this type is dedicated for cases created using Scalepoint FNoL flow - please don't use it for other purposes (e.g. not for case integration)</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health (optional), HUB  Motor (optional)</span></td>
</tr>
<tr>
<td>thirdPartyPolicies[].companyCode</td>
<td>Unique identifier for the Insurance Company, in Denmark use CVR numberIf caseType = <em>privateMedicalInsuranceClaim Use CVR 22656511 to set "Member of Sygesikring Danmark"</em></td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>thirdPartyPolicies[].name</td>
<td>Display name of Insurance Company</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>thirdPartyPolicies[].isMember</td>
<td>"yes", "no", "unknown"<br/></td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>thirdPartyPolicies[].policyType</td>
<td>Describes the policy or policies the claimant has in the other Insurance Company<span>If caseType = </span><em>privateMedicalInsuranceClaim and CVR 22656511 <em>"Member of Sygesikring Danmark" can be set by using the following values: "</em></em><em><em>1", "2", "5", "5Surgery", "Basic", "DontKnow"</em></em></td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>case</td>
<td>A point of extensions for non-generic case data</td>
<td>No<br /><span style="color: rgb(237,125,49);">Yes for subrogation</span></td>
</tr>
</tbody>
</table>

### Integration options

<table>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<thead>
<tbody>
<tr>
<td>integrationOptions. autoCompleteCreation</td>
<td>This option can be used to fully create the case (in contrast to having a case worker open the case wizard (if supported by case type) to finalize assignments and other options). <br />Using this option requires that <span style="color: rgb(91,155,213);"><em>assignTo</em></span> is also filled out.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor</span>, <span style="color: rgb(237,125,49);">HUB  Property</span></td>
</tr>
<tr>
<td>integrationOptions. startSelfService</td>
<td>This option can be used to automatically create the case and to initiate a selfservice invitation to the customer by sending out an email and an SMS (with password). <br />Using this option requires that <span style="color: rgb(91,155,213);"><em>customer.mobile</em></span> and <span style="color: rgb(91,155,213);"><em>customer.email</em></span> are filled out and valid.</td><td>No <br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>integrationOptions. skipSelfServiceNotification</td>
<td>This option can be used to skip initiating a selfservice invitation to the customer after the case is created. Instead, a link to selfservice will be provided in a response to the insurance company.</td><td>No <br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
</tbody>
</table>

### Questionaire

<table>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>questionnaire</td>
<td>This option can be used to transfer a set of question/answer pairs (e.g. may have been asked and answered on some other first notification of loss system). <br /> Both question and answer are freetext fields and will only be displayed in HUB  Property (not parsed or matched in any way).</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB Property only</span></td>
</tr>
</tbody>
</table>

### Policy

<table><colgroup><col><col><col></colgroup><thead ><tr><th    aria-label="JSON Path: No sort applied, activate to apply an ascending sort"><strong>JSON Path</strong></th><th    aria-label="Description: No sort applied, activate to apply an ascending sort"><strong>Description</strong></th><th    ><strong>Required</strong></th></tr></thead>
<tbody>
  <tr><td>policy.number</td><td>This is the policy number.</td><td>Yes <br /><span style="color: rgb(237,125,49);">HUB  Motor, HUB  Property, ClaimShop, HUB Health, ECX Required</span><br /><span style="color: rgb(237,125,49);">Subrogation optional</span></td></tr>
  <tr><td>policy.policyHolder.isDataProtected</td><td>Determines if policy holder contains protected data.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB only</span></td></tr>
  <tr><td>policy.policyHolder.name</td><td>Name of the policy holder. This can be the name of a person or the name of a company.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td></tr>
  <tr><td>policy.policyHolder.commercialTaxId</td><td>The commercial tax id is can be used if policy holder is describing a company.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB Health</span> <br /> <span style="color: rgb(237,125,49);">optional</span></td></tr>
  <tr><td>policy.policyHolder.email</td><td>The email address of the policy holder.</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.phone</td><td>Phone number of the policy holder.</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.mobile</td><td>A mobile phone number of the policy holder. <br /> This number are used when sending SMS messages. country prefix can be given as "+45" or "0045". <br />If number is provided without country code prefix, default country of the tenant is used. <br />Number after the country prefix can be numbers and spaces, no other special characters are allowed <br />Examples: "+45 12 34 56 78", "+4512345678".</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.address.street1</td><td>Street of policy holders address.</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.address.street2</td><td>Additional street information.</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.address.postalCode</td><td>Postal / zip code of the policy holders address</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.address.city</td><td>City of the policy holders address</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.address.state</td><td>State of the policy holders address <br /> For US only</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr><td>policy.policyHolder.address.country</td><td>Country of the policy holders address. <br /> For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. <br /> For exammple, to specify Denmark, one would use "<span style="color: rgb(91,155,213);"><em>dk</em></span>".</td><td>No <br /><span style="color: rgb(237,125,49);">Not currently used</span></td></tr>
  <tr>
  <td>policy.policyHolder.<span style="color: rgb(0,0,0);">disableNotifications</span></td>
  <td>When <em>true</em> - emails are disabled for policy holder. When <em>false</em> - emails are enabled to policy holder. When not provided - default existing logic in system will control flag value.</td>
  <td>No<br />ECX only</td>
  </tr>
  <tr>
  <td>policy.policyHolder.<span style="color: rgb(0,0,0);">disableSystemNotifications</span></td>
  <td>When <em>true</em> - system emails are disabled for policy holder. When <em>false</em> - system emails are enabled to policy holder. When not provided - default existing logic in system will control flag value.</td>
  <td>No<br />ECX only</td>
  </tr>
  <tr>
  <td>policy.policyHolder.<span style="color: rgb(0,0,0);">disableClaimPageAccess</span></td>
  <td>When <em>true</em> - myClaim access is disabled for policy holder. When <em>false</em> - myClaim access will be granted to policy holder. When not provided - default existing logic in system will control flag value.</td>
  <td>No<br />ECX only</td>
  </tr>
  <tr><td>policy.type</td><td>Policy type is used to describe a type of policy for which a certain set of depreciation rules apply. <br /> It doesn't need to match any predefined policy types in ClaimShop, but in order to set up depreciation rules in ClaimShop, it should be sent consistently. <br /> Examples: "<span style="color: rgb(91,155,213);"><em>1210</em></span>", "<span style="color: rgb(91,155,213);"><em>PRIV110</em></span>"</td><td>No <br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td></tr>
  <tr><td>policy.productAlias</td><td>List of allowed values defined in a configuration for "insuranceClaim" case type</td><td>No<br/><span style="color: rgb(237,125,49);">ECXoptional</span></td></tr>
  <tr><td>policy.productName</td><td>The policy product name is essentially the same as <span style="color: rgb(91,155,213);"><em>policy.type</em></span>, only where <span style="color: rgb(91,155,213);"><em>policy.type</em></span> may be a code, <span style="color: rgb(91,155,213);"><em>policy.productName</em></span> is a human readable description of the policy.type. <br /> This will only be used for presentation. <br /> Examples: "<span style="color: rgb(91,155,213);"><em>Private household basic</em></span>", "<span style="color: rgb(91,155,213);"><em>Commercial plus</em></span>"</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXoptional</span></td></tr>
  <tr><td>policy.conditions</td><td>Conditions that apply to the policy</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX Optional</span></td></tr>
  <tr><td>policy.vatSharePercentage</td><td>VAT share percentage is used in cases where a building is partly private and partly commercial. <br /> The VAT share percentage can be specified to indicate how much of the building is commercial.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr>
  <tr><td>policy.customerRating</td><td>Customer rating values can be passed here. It can be a system of "red", "yellow" and "green" (for ECC) or anything (for HUB  Property). <br /> In order to build logic on top of this, it should be consistent</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, ClaimShop</span></td></tr>
  <tr><td>policy.serviceLevel</td><td>Service level is used to determine what kind of service a customer has purchased. Any value can be sent, but in order to build login on top of this, it should be consistent. <br /> Examples: "Basic", "Silver", "Gold"</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td></tr>
  <tr><td>policy.deductible.value</td><td>The deductible is the amount of expenses that must be paid by the policy holder. If omitted, a deductible of 0.00 will be assumed. <br /> Must be specified in US format without thousind dilimiters (e.g. 5000.00)</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, ClaimShop, HUB Health, ECXoptional</span></td></tr>
  <tr><td>policy.deductible. <br /> percentage</td><td>Deductible can be specified as a percentage of the replacement. In this case deductible should not be specified as value. <br /> Deductible percentage should be a number between 0 and 100</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr>
  <tr><td>policy.deductible.minValue</td><td>If a deductible percentage is specified, optionally a minimum deductible value can be specified.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr>
  <tr><td>policy.deductible.maxValue</td><td>If a deductible percentage is specified, optionally a maximum deductible value can be specified.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr>
  <tr><td>policy.deductible.conditionalItemValue</td><td>The deductible can be defined as the value per item that the policy holder should cover. In this case deductible should not be specified as value. Must be specified in US format without thousind dilimiters (e.g. 5000.00)</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property Only</span></td></tr>
  <tr><td>policy.deductible.conditionalItemsCount</td><td>The number of items to be deducted when conditional deductible item value is set. Must be a positive integer. Default is 1. This number multiplies conditional item value.<br /> <span style="font-family: monospace"> conditionalItemValue * conditionalItemsCount = totalDeductible </span> </td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property Only</span></td></tr>
  <tr><td>policy.deductible.conditionalTotalValueModifier</td><td>Adjustment to total deductible when conditional deductible item value is set. Must be a integer. This number is added to conditional deductible total.<br /> <span style="font-family: monospace"> (conditionalItemValue * conditionalItemsCount) + conditionalTotalValueModifier = totalDeductible </span> </td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property Only</span></td></tr>
  <tr><td>policy.deductible.comment</td><td>This is intended to be a comment for the deductible. For example if deductible is changing based on number of claims per year or some other factor, an explanation of the deductible could be given here.</td><td>No <br /><span style="color: rgb(237,125,49);">Not used</span></td></tr>
  <tr><td>policy.specialCoverage</td><td>If there is any special special coverage on the policy, it can be specified with this parameter. <br /> The field is a freetext field, used only as reference in HUB  Property.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXoptional</span></td></tr>
  <tr><td>policy.clauses</td><td>Clauses that apply to the policy can be specified with this parameter. <br /> The field is a freetext field, used only as reference in HUB  Property.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXoptional</span></td></tr>
  <tr><td>policy.remarks</td><td><span>Any policy remarks can be specified with this parameter.</span><br /><span>The field is a freetext field, used only as reference in HUB  Property.</span></td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXoptional</span></td></tr>
  <tr><td>policy.data</td><td>Described in Appendix F - Descriptive content format</td><td>No<br/><span style="color: rgb(237,125,49);">ECX optional</span></td></tr>
  <tr><td>policy.numberOfPeopleCovered</td><td>Number of people covered with this policy based on this value audit could take decision. used only as reference in ClaimShop.</td><td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td></tr>
  <tr><td>policy.<span style="color: rgb(0,0,0);">coverageWithNewTermsAndConditions</span></td><td>Based on this value, audit could take decision. Want to know if the claim is covered with new terms and conditions or not. used only as reference in ClaimShop</td><td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td></tr>
  <tr><td>policy.coverageId</td><td>Want to know what is the coverageId so based on this value audit could take decision about the claim. This is a free text and used only as reference in ClaimShop</td><td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td></tr>
  <tr><td>policy.coverageLimit</td><td>Policy coverage amount limit, so based on this value audit could take decision about the claim. Must be specified in US format without thousind dilimiters (e.g. 5000.00) and used only in ClaimShop</td><td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td></tr>
  <tr><td>policy.policyStartModificationDate</td><td>Policy start date or last policy modification date. <br />
  Date/time format should follow ISO-8601</td><td>No<br/><span style="color: rgb(237,125,49);">HUB only</span></td></tr>
</tbody></table>

### Customer

<table>
<colgroup>
<col />
<col />
<col />
</colgroup>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>customer.isDataProtected</td>
<td>Determines if customer contains protected data.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB only</span></td>
</tr>
<tr>
<td>customer.customerId</td>
<td>If the customer has a reference id in your own system, this value can be sent with this parameter.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor, ClaimShop</span></td>
</tr>
<tr>
<td>customer.firstName</td>
<td>First name of the customer</td>
<td>No <br />
<span style="color: rgb(237,125,49);">HUB Health required,</span>
<span style="color: rgb(237,125,49);">ClaimShop required,</span>
<span style="color: rgb(237,125,49);">HUB  Motor, HUB  Property, ECX Optional</span>
</td>
</tr>
<tr>
<td>customer.lastName</td>
<td>Last name of the customer</td>
<td>No<br />
<span style="color: rgb(237,125,49);">HUB Health required,</span>
<span style="color: rgb(237,125,49);">ClaimShop required,</span>
<span style="color: rgb(237,125,49);">HUB  Motor, HUB  Property, ECX Optional</span>
<span style="color: rgb(237,125,49);"></span>
</td>
</tr>
<tr>
<td>customer.salutation</td>
<td>How to salute customer. For example "Mr.", "Miss" or "Mrs."</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.email</td>
<td>Email address of the customer</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health</span><span style="color: rgb(237,125,49);">optional</span>
<span style="color: rgb(237,125,49);"></span>
<span style="color: rgb(237,125,49);">ClaimShop, HUB  Motor, HUB  Property, ECX Optional</span>
<span style="color: rgb(237,125,49);"></span>
</td>
</tr>
<tr>
<td>customer.phone</td>
<td>Phone number of the customer</td>
<td>No<br />
<span style="color: rgb(237,125,49);">HUB Health, ECX, ClaimShop</span>
<span style="color: rgb(237,125,49);">optional</span>
</td>
</tr>
<tr>
<td>customer.mobile</td>
<td>A mobile phone number of the customer.
<br />This number are used when sending SMS messages. country prefix can be given as "+45" or "0045". <br />If number is provided without country code prefix, default country of the tenant is used. <br />Number after the country prefix can be numbers and spaces, no other special characters are allowed <br />Examples: "+45 12 34 56 78", "+4512345678".
</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health, ECXoptional</span></td>
</tr>
<tr>
<td>customer.comment</td>
<td>Remark or comment about the customer</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXoptional</span></td>
</tr>
<tr>
<td>customer.address.street1</td>
<td>Street of customers address.</td>
<td>No<br />
<span style="color: rgb(237,125,49);">ClaimShop required, HUB Health, ECXrequired</span>
</td>
</tr>
<tr>
<td>customer.address.street2</td>
<td>Additional street information.</td>
<td>No
<span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX Optional</span>
<span style="color: rgb(237,125,49);">ClaimShop optional, HUB  Motor ?</span>
</td>
</tr>
<tr>
<td>customer.address.postalCode</td>
<td>Postal / zip code of the customers address</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health required</span>
<span style="color: rgb(237,125,49);">ClaimShop optional, ECX Optional</span>
</td>
</tr>
<tr>
<td>customer.address.city</td>
<td>City of the customers address</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB Health required</span>
<span style="color: rgb(237,125,49);">ClaimShop optional</span>
<span style="color: rgb(237,125,49);">ECX Optional</span>
</td>
</tr>
<tr>
<td>customer.address.state</td>
<td>State of the customer address<br />For US only</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.address.country</td>
<td>Country of the customers address.<br />For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase.
<br />For exammple, to specify Denmark, one would use "
<span style="color: rgb(91,155,213);">
<em>dk</em>
</span>".
</td>
<td>No<br /><span style="color: rgb(237,125,49);">Not used</span></td>
</tr>
<tr>
<td>customer.personalTaxId</td>
<td>This is the customers social security number. Only used in Denmark (CPR number).
<br />Should be specified as 10 digits with no punctuation.
</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop, HUB Health optional</span></td>
</tr>
<tr>
<td>customer.paymentDetails</td>
<td>A number of payment details can be specified for the customer.</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span>
</td>
</tr>
<tr>
<td>customer.paymentDetails[].type</td>
<td>Specifies the type of bank account.
<br />Allowed values are: "
<span style="color: rgb(91,155,213);">
<em>bankAccount</em>
</span>" or "
<span style="color: rgb(91,155,213);">
<em>iban</em>
</span>"
</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.paymentDetails[].registrationNumber</td>
<td>Registration number for the customers bank account.<br />This should be specified only if "type" is "bankAccount"</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.paymentDetails[].accountNumber</td>
<td>Account number for the customers bank account.
<br />This should be specified only if "type" is "bankAccount"
</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.paymentDetails[].iban</td>
<td>IBAN account of the customer. This should be specified only if "type" is "iban"</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.paymentDetails[].swift</td>
<td>SWIFT code of the customer. This should be specified only if "type" is "iban"</td>
<td>No<br /><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.type</td>
<td>Want to know what type of customer is he/she, based on this value, audit could take decision. its used as free text and used only as reference in ClaimShop</td>
<td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.<span style="color: rgb(0,0,0);">liveOutsideHomeMunicipality</span></td>
<td>Want to know whether the claimant live inside his home municipality and based on the value audit could take a decision about the claim. only as reference in ClaimShop</td>
<td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.<span style="color: rgb(0,0,0);">personalAssociationCode</span></td>
<td>Want to know whether the claimant have any personal association code and based on the value audit could take a decision about the claim. Its used as free text and used only as reference in ClaimShop</td>
<td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.<span style="color: rgb(0,0,0);">personalTravelCardNumber</span></td>
<td>Want to know whether the claimant have any personal travel card number and based on the value audit could take a decision about the claim. Its used as free text and used only as reference in ClaimShop</td>
<td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
</tr>
<tr>
<td>customer.<span style="color: rgb(0,0,0);">disableNotifications</span></td>
<td>When <em>true</em> - emails are disabled for claimant. When <em>false</em> - emails are enabled to claimant. When not provided - default existing logic in system will control flag value.</td>
<td>No<br />ECX only</td>
</tr>
<tr>
<td>customer.<span style="color: rgb(0,0,0);">disableSystemNotifications</span></td>
<td>When <em>true</em> - system emails are disabled for claimant. When <em>false</em> - system emails are enabled to claimant. When not provided - default existing logic in system will control flag value.</td>
<td>No<br />ECX only</td>
</tr>
<tr>
<td>customer.<span style="color: rgb(0,0,0);">disableClaimPageAccess</span></td>
<td>When <em>true</em> - myClaim access is disabled for claimant. When <em>false</em> - myClaim access will be granted to claimant. When not provided - default existing logic in system will control flag value.</td>
<td>No<br />ECX only</td>
</tr>
</tbody>
</table>

### 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:

<table>
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead>
<tr><th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><span>contacts[]</span>.isDataProtected</td>
<td>Determines if contact contains protected data.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB only</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.firstName</td>
<td>First name of the contact.</td>
<td>No<sup>*</sup><br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXoptional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.lastName</td>
<td>Last name of the contact.</td>
<td>No<sup>*</sup><br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.name</td>
<td>The name of the contact.</td>
<td>No<sup>*</sup><br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX, Subrogation optional</span><br /><sup>*</sup>Either `firstName` and `lastName`, or `name` should be specified</td>
</tr>
<tr>
<td><span>contacts[]</span>.salutation</td>
<td>How to salute contact. For example "Mr.", "Miss" or "Mrs."</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.email</td>
<td>Email address of the <span>contact.</span></td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.phone</td>
<td>Phone number of the <span>contact.</span></td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.mobile</td>
<td>A mobile phone number of the contact. <br />This number are used when sending SMS messages. country prefix can be given as "+45" or "0045". <br />If number is provided without country code prefix, default country of the tenant is used. <br />Number after the country prefix can be numbers and spaces, no other special characters are allowed <br />Examples: "+45 12 34 56 78", "+4512345678".</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td></tr>
<tr>
<td><span>contacts</span>[].commercialTaxId</td>
<td>The commercial tax id is can be used if contact is describing a company.</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.comment</td>
<td>Remark or comment about the <span>contact.</span></td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.relation</td>
<td><span>Contact</span> relation</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX, Subrogation optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.isExternal</td>
<td>Defines whether the <span>contact</span> is external or not</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECXm Subrogation optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.street</td>
<td>Street of <span>contact's </span>address.</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.street2</td>
<td>Additional street information.</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr
><td><span>contacts[]</span>.postalCode</td>
<td>Postal / zip code of the <span>contact's </span>address.</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.city</td>
<td>City of the <span>contact's </span>address.</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
<tr>
<td><span>contacts[]</span>.disableClaimPageAccess</td>
<td>When <em>true</em> - myClaim access is disabled for claim contact. When <em>false</em> - myClaim access will be granted to claim contact. When not provided - default existing logic in system will control flag value.</td>
<td>No<br /><span style="color: rgb(237,125,49);">HUB  Property, HUB Health, ECX optional</span></td>
</tr>
</tbody>
</table>

### Loss

<table>
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>loss.type</td>
<td>This can be used to describe the type of loss or damage. <br /> Specific values apply to different applications. <br /> Please see Appendix B – Damage Types for a list of possible values.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor, HUB  Property, ECX</span></td>
</tr>
<tr>
<td>loss.subType</td>
<td>To further describe the loss or damage, this can be used. <br /> Please see Appendix B – Damage Types for a list of possible values.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Property, ECXonly</span></td>
</tr>
<tr>
<td>loss.description</td>
<td>Description of the damage or loss</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor, HUB  Property, HUB Health, ECXOptional</span></td>
</tr>
<tr>
<td>loss.reserve</td>
<td>To be used for health</td>
<td>No <br /> <span style="color: rgb(237,125,49);">HUB  Property, ECXonly</span><br /> <span style="color: rgb(237,125,49);"></span></td>
</tr>
<tr>
<td>loss.coverage</td>
<td>This is used to specify whether case is covered or not.Please refer to Appendix H for allowed values.</td>
<td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
</tr>
<tr>
<td>loss.coverageReason</td>
<td>This is description in addition to specified coverage.</td>
<td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
</tr>
</tbody>
</table>

### 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](#case)*
<table>
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>loss.vehicle.type</td>
<td>This describes the vehicle type (e.g. "car", "motorbike", "van")</td>
<td>No <br /><span style="color: rgb(237,125,49);">Not used</span></td>
</tr>
<tr>
<td>loss.vehicle. <br /> licensePlateNo</td>
<td>The licenseplate of the vehicle. <br /> Should be specified without any punctuation.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle.brand</td>
<td>The brand of the vehicle (e.g. "BMW", "Volvo" or "Ford")</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle.model</td>
<td>Model description of the vehicle (e.g. "320 Touring", "V70" or "Mondeo")</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle.variant</td>
<td>This describes the specific variant of the vehicle model (e.g. "1,2 AUT.", "1,8i Sedan" or "2,4 D5)</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle.year</td>
<td>The year when the vehicle was produced. <br /> Should be in the format "<span style="color: rgb(91,155,213);"><em>yyyy</em></span>" (e.g. "1998" or "2005")</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle.chassisNo</td>
<td>Chassis number of the vehicle</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle.location. <br /> postalCode</td>
<td>The vehicle location postalcode, can be specified if the vehicle is located at another location than "<span style="color: rgb(91,155,213);"><em>customer.address</em></span>". <br /> If specified, this postal code will be used to locate nearest repairshop, otherwise "<span style="color: rgb(91,155,213);"><em>customer.address</em></span>" will be used.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
<tr>
<td>loss.vehicle. <br /> damageAreas.[]</td>
<td>The damage areas is a list of areas on the vehicle where there is a damage. <br /> Please refer to Appendix C – Vehicle damage areas for a list of possible values.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
</tr>
</tbody>
</table>

### Loss building

<table><colgroup><col><col><col></colgroup><thead ><tr><th    aria-label="JSON Path: No sort applied, activate to apply an ascending sort"><strong>JSON Path</strong></th><th    aria-label="Description: No sort applied, activate to apply an ascending sort"><strong>Description</strong></th><th    ><strong>Required</strong></th></tr></thead>
<tbody><tr><td>loss.building.sector</td><td>Sector is a code, which can be any one of the ones defined in Appendix D – Building sectors.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.address. <br /> street1</td><td>Street of building address. <br />HUB Health: Building.address is Primary Address, used when finding closest service provider</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.address. <br /> street2</td><td>Additional building information.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.address. <br /> postalCode</td><td>Postal / zip code of the building address</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.address. <br /> city</td><td>City of the building address</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.address. <br /> state</td><td>State of the building address <br /> For US only</td><td>No <br /><span style="color: rgb(237,125,49);">Not used</span></td></tr><tr><td>loss.building.address. <br /> country</td><td>Country of the customers address. <br /> For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. <br /> For exammple, to specify Denmark, one would use "<span style="color: rgb(91,155,213);"><em>dk</em></span>".</td><td>No <br /><span style="color: rgb(237,125,49);">Not used</span></td></tr><tr><td>loss.building.buildingYear</td><td>Building year indicates the year the building was completed. <br /> Should be in the format "<span style="color: rgb(91,155,213);"><em>yyyy</em></span>" (e.g. "1965" or "2000")</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building. <br /> livingArea</td><td>Indicates the amount of space of the building which is living area (e.g. "200 m2") <br /> This is a string value and as such there are no specific format to be used.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building. <br /> basementArea</td><td>Indicates the amount of space of the building which is basement area (e.g. "75 m2") <br /> This is a string value and as such there are no specific format to be used.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building. <br /> garageOutbuildingArea</td><td>Indicates the amount of space which is occupied by a garage or other outdoor building areas (e.g. "50 m2"). <br /> This is a string value and as such there are no specific format to be used.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.roofType</td><td>This can be use to specify the type of roof on the building. <br /> This is a string value and as such there are no specific format to be used. (max 50 chars)</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building.timber</td><td>Use to indicate if the building is a timber framing building (danish: bindingsværk). <br /> Allowed values: "<span style="color: rgb(91,155,213);"><em>true</em></span>" or "<span style="color: rgb(91,155,213);"><em>false</em></span>".</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building. <br /> conditionReport</td><td>Use this to indicate whether a condition report for the building exists. <br /> Allowed values: "<span style="color: rgb(91,155,213);"><em>true</em></span>" or "<span style="color: rgb(91,155,213);"><em>false</em></span>".</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>loss.building<span>. </span><br /><span></span>propertyUnits[]</td><td>Use to specify collection of property units. For example for several buildings on a commercial claim</td><td>No<br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>loss.building</span><span>. </span><br /><span></span><span>propertyUnits[].unit</span></td><td>Name of the unit</td><td><span>Yes </span><br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>loss.building</span><span>. </span><br /><span></span><span>propertyUnits[].description</span></td><td>Description of the unit</td><td><span>No </span><br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>loss.building</span><span>. </span><br /><span></span><span>propertyUnits[].constructionYear</span></td><td><span>Unit construction year indicates the year the building was completed. </span><br /><span> Should be in the integer format "</span><span style="color: rgb(91,155,213);"><em>yyyy</em></span><span>" (e.g. 1965 or 2000)</span></td><td><span>No </span><br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>loss.building</span><span>. </span><br /><span></span><span>propertyUnits[].buildingArea</span></td><td><span>Indicates the amount of space of the building </span><br /><span> This is a number value <span>(e.g. 200.5)</span></span></td><td><span>No </span><br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>loss.building</span><span>. </span><br /><span></span><span>propertyUnits[].numberOfFloors</span></td><td><span>Indicates the amount floors in the building </span><br /><span> This is an integer value <span>(e.g. 4)</span></span></td><td><span>No </span><br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>loss.building</span><span>. </span><br /><span></span><span>propertyUnits[].roofType</span></td><td><span>Indicates the type of the roof. valid values are: Hard, Thatch, BuildUp, Turf (max 50 chars)</span><span></span></td><td><span>No </span><br /><span></span><br /><span></span><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr></tbody></table>

### Loss health

<table>
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th>JSON Path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>loss.health.sector</td>
<td>Sector is a code, which can be any one of the ones defined in <a href="#External-ScalepointCaseIntegrationAPI-_Appendix_D.1_–">Appendix D.1 – Health sectors</a>.</td>
<td><span style="color: rgb(237,125,49);"></span>No <br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>loss.health.diagnosisCode</td>
<td>Initial Diagnosis code set by claimhandler.eks. "KAAB00-Excision af intrakranielt patologisk væv"(Not yet reflected in implementation)</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>loss.health.referralFromDoctor</td>
<td>Have the claimant been to his local doctor and have been refered to a type of treatment"Yes"<br>"No"<br>"DontKnow"(Not yet reflected in implementation)</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>loss.health.medicalConsentDocumentReceived</td>
<td>"Yes"<br>"No"<br>"NotRelevant"(Not yet reflected in implementation)</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
<tr>
<td>loss.health.serviceType</td>
<td>"hospitalTreatment""mentalTreatment""physicalTreatment""otherTreatment"</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB Health optional</span></td>
</tr>
</tbody>
</table>

### Risk Assessment

<table>
<colgroup>
<col style="width: 20%;">
<col style="width: 70%;">
<col style="width: 10%;">
</colgroup>
<thead ><tr><th    aria-label="JSON Path: No sort applied, activate to apply an ascending sort"><strong>JSON Path</strong></th><th    aria-label="Description: No sort applied, activate to apply an ascending sort"><strong>Description</strong></th><th    ><strong>Required</strong></th></tr></thead><thead  style="display: none;"><tr><th    aria-label="JSON Path: No sort applied, activate to apply an ascending sort"><strong>JSON Path</strong></th><th    aria-label="Description: No sort applied, activate to apply an ascending sort"><strong>Description</strong></th><th    ><strong>Required</strong></th></tr></thead><tbody><tr><td><span>riskAssessment</span>.address. <br /> street1</td><td>Street of building address.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.</span>address. <br /> street2</td><td>Additional building information.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment</span>.address. <br /> postalCode</td><td>Postal / zip code of the building address</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.</span>address. <br /> city</td><td>City of the building address</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment</span>.address. <br /> state</td><td>State of the building address <br /> For US only</td><td>No <br /><span style="color: rgb(237,125,49);">Not used</span></td></tr><tr><td><span>riskAssessment</span>.address. <br /> country</td><td>Country of the customers address. <br /> For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. <br /> For exammple, to specify Denmark, one would use "<span style="color: rgb(91,155,213);"><em>dk</em></span>".</td><td>No <br /><span style="color: rgb(237,125,49);">Not used</span></td></tr><tr><td><span>riskAssessment.clauses[]</span></td><td>Clauses grouped by categories</td><td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.clauses[].name</td><td>Clause category name</td><td>Yes<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.clauses[].items[]</span></td><td>Clauses in the category</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.clauses[].items[].name</span></td><td>Clause name</td><td><span>Yes</span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.clauses[].items[].description</span></td><td>Clause description</td><td>Yes<br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.coverages[]</span></td><td>Coverages selected for risk assessment</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.coverages[].name</span></td><td>Coverage name</td><td><span>Yes </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.coverages[].checked</span></td><td>Specifies if coverage is pre-selected</td><td><span>Yes </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.riskAssessmentConditions</td><td>Risk assessment conditions</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.inspectionCoverageFeedback[]</span></td><td>Risk assessment inspection feedback</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.inspectionCoverageFeedback[].name</span></td><td><span>Risk assessment inspection feedback name</span></td><td><span>Yes </span><br /><span></span><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.inspectionCoverageFeedback[].checked</span></td><td><span>Risk assessment inspection feedback </span>should is selected</td><td><span>Yes </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.enabledBuildingProperties[]</span></td><td>Lists names of risk assessment building properties which are visible and can be edited in HUB  Property. Properties not included here will be hidden.<br /><span>If omitted then no building properties can be presented and buildings will be hidden.</span><br /><span>Supported values are: "number", "description", "constructionYear", "buildingArea", "livingArea", "loftArea", "loftLivingArea", "basementLivingArea", "externalWall", "roof", "roofDeck", "foundation", "details".</span></td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.additionalCoverages[]</td><td>Lists additional possible coverages per building.<br/></td><td>No <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.additionalCoverages[].name</td><td>Name of coverage.<br/></td><td>Yes <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.additionalCoverages[].type</td><td>Type of coverage. Supported values are: "boolean", "string", "number", "enum". For "enum", additional property "items" is required.<br/></td><td>Yes <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.additionalCoverages[].items</td><td>List of possible option for additional coverage. Required if additional coverage is of type "enum".<br/></td><td>Yes <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.additionalCoverages[].items[].name</td><td>Display name for a single option for additional coverage of type "enum".<br/></td><td>Yes <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.additionalCoverages[].items[].value</td><td>Technical value for a single option for additional coverage of type "enum".<br/></td><td>Yes <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.buildings[]</span></td><td>Specifies building that should be inspected</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].name</span></td><td>Building name</td><td><span>Yes </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].description</span></td><td>Building description</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].type</span></td><td>Building type.<br><span>Valid values are: villa, leisurehome, gardenhouse, closedfarm, closedproductionbuilding, townhouse, allotmenthouse, apartmentbuilding, farm, commercialbuilding, shed, other</span></td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.buildings[].typeA1</td><td>Alternative building type #1.<br>Valid values are: villa, leisurehome, gardenhouse, closedfarm, closedproductionbuilding, townhouse</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].typeA2</td><td>Alternative building type #2.<br>Valid values are: parcel, leisurehome, gardenhouse, closedfarm, closedproductionbuilding</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].typeA3</td><td>Alternative building type #3.<br>Valid values are: leisurehome, villa, townhouse, allotmenthouse</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].typeA4</td><td>Alternative building type #4.<br>Valid values are: parcel, leisurehome, gardenhouse, cottage, caravan, trailer</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.buildings[].use</span></td><td><span>Describes how building is used.<br><span>Valid values are: residential, rent, residentialandcommercial, commercial, agriculture, agricultureandcommercial, other</span></span></td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.buildings[].useA1</td><td>Alternative building use description #1.<br>Valid values are: residential, rent, residentialandcommercial</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].useA2</td><td><span>Alternative building use description #2</span>.<br>Valid values are: leisure, leisurerent</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.buildings[].constructionYear</span></td><td>Building construction year</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].numberOfFloorsWithoutBasement</span></td><td>Number of building floors without basement</td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].buildingArea</span></td><td>Building area</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].livingArea</span></td><td>Building living area</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].loftArea</span></td><td>Building loft area</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].loftLivingArea</span></td><td>Building loft living area</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].basementArea</span></td><td>Building basement area</td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].basementLivingArea</span></td><td>Building basement living area</td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].numberOfToilets</span></td><td>Number of building toilets</td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].heating</span></td><td>Building heating type.<br><span>Valid values are: electric, district, naturalgas, oil, stokerboilers, strawboilers, geothermal, solarpanels, heatpumpairtowater, heatpumpairtoair, underfloorheating, underfloorheatingcopper, pelletburnercertified, other</span></td><td>No<br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.buildings[].heatingA1</td><td>Alternative building heating type.<br>Valid values are: electric, district, central, boilers, other</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.buildings[].externalWall</span></td><td>Building external wall type. <br>Valid values are: brick, wood, lightweightconcrete, concrete, timberframing, concreteelements, stone, eternit, steel, aluminium, glass, other</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].roof</span></td><td>Building roof typeValid values are: gridrafter, collarbeam, highrafter, beamrafter, lowroundrafter, concrete, singlesloped, flat, dachhip, other</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.buildings[].roofA1</td><td>Alternative building roof type.<br><span>Valid values are: solid, flat, greennature, thatchedfireproof, thatchednotfireproof</span></td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.buildings[].roofDeck</span></td><td>Building roof deck typeValid values are: roofingfelt, roofingtiles, concretetiles, eternit, steel, thatched, thatchedfireproof, thatchedfirecloth, slate, eternitslate, onduline, copper, zinc, aluminium, cardboard, cuts, greennature, open, other</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td><span>riskAssessment.buildings[].foundation</span></td><td>Building foundation typeValid values are: concrete, stone, brick, none, earth, pointfoundation, other</td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.buildings[].otherBuildingsArea</td><td>Other property buildings area</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].otherBuildingsRoof</td><td>Other property buildings roof type.<br>Valid values are: na, thatched, other</td><td>No<br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td><span>riskAssessment.buildings[].details</span></td><td>Building additional details<br/></td><td><span>No </span><br /><span></span><br /><span><span style="color: rgb(237,125,49);">HUB  Property only</span></span></td></tr><tr><td>riskAssessment.buildings[].coverages[]</td><td>Lists additional coverage for building.<br/></td><td>No <br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].coverages[].name</td><td>Name of additional coverage. Must be one of the names listed in <span>riskAssessment.additionalCoverages[].</span><br/></td><td>Yes<br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr><tr><td>riskAssessment.buildings[].coverages[].value</td><td>Value of additional coverage. Must have the same type as corresponding type listed in riskAssessment.additionalCoverages[]. The exact additional coverage will be found by coverage name.<br/></td><td>No<br /><br /><span style="color: rgb(237,125,49);">HUB  Property only</span></td></tr></tbody></table>

### Extra modifiers

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

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

<table>
    <colgroup>
        <col>
        <col>
        <col>
    </colgroup>
    <thead>
    <tr>
        <th aria-label="Modifier code: No sort applied, activate to apply an ascending sort">
            <strong>Modifier code</strong>
        </th>
        <th aria-label="Description: No sort applied, activate to apply an ascending sort">
            <strong>Description</strong>
        </th>
        <th>
            <strong>Required</strong>
        </th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td>propertyCode</td>
        <td>A property code is an extra code that is linked to the vehicle type and which can be used in HUB  Motor to select certain repairshops over others. <br/> The property codes have to be defined in HUB  Motor beforehand.</td>
        <td>No <br/><span style="color: rgb(237,125,49);">HUB  Motor only</span></td>
    </tr>
    <tr>
        <td>inspectionType</td>
        <td>Sets the inspection type, to be used for the case. <br/> Allowed values are:
            "<span style="color: rgb(91,155,213);"><em>any</em></span>",
            "<span style="color: rgb(91,155,213);"><em>field</em></span>",
            "<span style="color: rgb(91,155,213);"><em>desk</em></span>"
            and "<span style="color: rgb(91,155,213);"><em>content</em></span>".
            <br/> Only one inspectionType should be used for a case.
        </td>
        <td>No <br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td><span>typeOfHiddenPlacesPipes</span></td>
        <td>required follow-up question for <span>loss.subType = HiddenPlaces. <span>PossibleValues : "HeatingPipes", "FloorHeating", "FloorHeatingElectrical", "Water", "Sewer", "DownPipe", "WhiteGoodPipes", "Unknown", "HiddenWaterOrHeatingPipes", "HiddenDrainPipes", "VisiblePipes", "Other"</span></span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td><span>typeOfServicePipes</span></td>
        <td>required follow-up question for <span>loss.subType = ServicePipes</span><span>. <span>PossibleValues : <span>PossibleValues : "Sewer", "Electrical", "Water", "ExteriorHeating", "Unknown", "PhoneAntennaCable", "Other"<br></span></span></span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td><span>leakType</span></td>
        <td>required follow-up question for <span>loss.subType = HiddenPlaces. <span>PossibleValues : "Leak", "OilLeak", "SlowRunningWater", "Other"</span></span><span></span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td><span>damageToRoof</span></td>
        <td><span>required follow-up question for </span><span>loss.type = StormDamage, <span>loss.subType=Storm, </span><span>loss.subType = 'StormRain' </span></span><span> PossibleValues : "Yes", "No"</span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td>stormDamageRoofType</td>
        <td><span>required follow-up question for <span>damageToRoof</span><span> = Yes.</span><span></span></span><span>PossibleValues : "RoofingTile", "RoofingFelt", "<span>Other</span>"</span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td><span style="color: rgb(255,17,0);">[<b>deprecated</b>]</span><br /><span>windowsCount</span></td>
        <td><span>required follow-up question for loss.type = RotInsectDamage. Integer value greater than 0. Windowscount > 0 requeries conditional deductible should be set manually (warning). </span><br /><span>NOTE: Use <span style="font-family: monospace">policy.deductible.conditionalItemsCount</span> instead. Value from <span style="font-family: monospace">conditionalItemsCount</span> overrides when set together. </span></td>
        <td>No<br/><span style="color: rgb(244,41,65);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td><span>damageCauseDescription</span></td>
        <td>required follow-up question for <span>loss.subType = Other. Free text description of the damage cause</span><span></span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property, ClaimShop, ContentItemization</span></td>
    </tr>
    <tr>
        <td><span>leakTypeOtherDescription</span></td>
        <td>required follow-up question for <span>extraModifiers.type = "leakType" and extraModifiers.value = "Other". <span>Free text description of the leak type</span></span><span></span></td>
        <td>No<br/><span style="color: rgb(237,125,49);">HUB  Property only</span></td>
    </tr>
    <tr>
        <td>postItemizationCompletedUrl</td>
        <td>Claimant will be redirected to this URL after content itemization completion.</td>
        <td>No<br/><span style="color: rgb(237,125,49);">ContentItemization only</span></td>
    </tr>
    <tr>
        <td>sourceOfFNOL</td>
        <td>defines who initiated the FNOL process, possible values are "claimant" or "claimhandler"</td>
        <td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
    </tr>
    <tr>
        <td>policyType</td>
        <td>defines that provided policy is not complete and is just a reference that could be used to obtain full policy details. Possible value "reference"</td>
        <td>No<br/></td>
    </tr>
    <tr>
        <td>policyHolderIsClaimant</td>
        <td>boolean value that indicates if policy holder should be treated as claimant on the case</td>
        <td>No</td>
    </tr>
    <tr>
        <td>extraDataForAutomation</td>
        <td>string value that will be sent to AI CC in Settlement, RV and Bestfit flows</td>
        <td>No<br/><span style="color: rgb(237,125,49);">ClaimShop only</span></td>
    </tr>
    <tr>
        <td><span>nameAndAddressProtected</span></td>
        <td>boolean value that indicates that the claimant has his name and address under protection in ECC</td>
        <td>No<br/><span style="color: rgb(237,125,49);">ClaimShop</span></td>
    </tr>
    </tbody>
</table>

Examples:

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

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

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

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

```json
"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:

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

<table>
<thead>
<tr>
<th>Role</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseOwner</td>
<td>Can be used to assign the case-owner / creator of the case. Field "email" or "autoAssign" will be required as well.</td>
<td>Yes <br /><span style="color: rgb(237,125,49);">ClaimShop, HUB  Property, HUB  Motor</span></td>
</tr>
<tr>
<td>networkCraftsman</td>
<td>Can be used to assign a network craftsman. If the field: "autoAssign" is true, a craftsman from the network will automatically be assigned, based on location, profession and other settings.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Property</span></td>
</tr>
<tr>
<td>externalCraftsman</td>
<td>This can be used to assign an external craftsman. The field: "email" will then be used to specify an email of the external craftsman. <br /> The "damageExtent" field can be used to give a damage description for the external craftsman.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Property</span></td>
</tr>
<tr>
<td>damageService</td>
<td>This role can be used to assign a damage service company. Field "autoAssign" is used to automatically find the closed one. <br /> Field: "isAcute" is to indicate ugency.</td><td>No <br /><span style="color: rgb(237,125,49);">HUB  Property</span></td>
</tr>
<tr>
<td>riskAssessor</td>
<td>This role can be used to assign assessor for a risk assessment service. Field "autoAssign" is used to automatically find the best one.<br>If insurance company treats field and desk assessors separately <span style="color: rgb(91,155,213);"><em>extraModifiers</em></span> item with type "inspectionType" is used to specify assessor type</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB  Property</span></td>
<tr>
<td>assessor</td>
<td>This role can be used to assign assessor for vehicleRepair service and buildingRepair service. Field "autoAssign" is used to automatically find the best one.</td>
<td>No <br /><span style="color: rgb(237,125,49);">HUB Motor<br>HUB Property</span></td>
</tr>
</tbody>
</table>

#### services []

<table>
<colgroup>
<col style="width: 15%;">
<col style="width: 70%;">
<col style="width: 15%;">
</colgroup>
<thead>
<tr>
<th>services[].</th>
<th>Description</th>
<th >Support</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>Type of the service. Supported values are: "<span style="color: rgb(91,155,213);"><em>vehicleRepair</em></span>", <span>"</span><span style="color: rgb(91,155,213);"><em>buildingInspection</em></span><span>", <span>"</span><span style="color: rgb(91,155,213);"><em>buildingRepair</em></span><span>"</span></span></td><td><ul><li>all:<strong>required</strong></li></ul></td>
</tr>
</tbody>
</table>

### 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:

```json
"damageAddress": {
    "street1": "streetName",
    "street2": "",
    "postalCode": "1234",
    "city": "City Name",
    "state": "",
    "country": "dk"
  }
```
<table>
<thead>
<tr>
<th>Role</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>damageAddress.street1</td>
<td>Street of custom damage address.</td>
<td>No<br />
</td>
</tr>
<tr>
<td>damageAddress.street2</td>
<td>Additional street information.</td>
<td>No
</td>
</tr>
<tr>
<td>damageAddress.postalCode</td>
<td>Postal / zip code of the custom damage address</td>
<td>No<br />
</td>
</tr>
<tr>
<td>damageAddress.city</td>
<td>City of the custom damage address</td>
<td>No<br />
</td>
</tr>
<tr>
<td>damageAddress.state</td>
<td>State of the custom damage address<br />For US only</td>
<td>No<br />
</tr>
<tr>
<td>damageAddress.country</td>
<td>Country of the custom damage address.<br />For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase.
<br />For example, to specify Denmark, one would use "
<span style="color: rgb(91,155,213);">
<em>dk</em>
</span>".
</td>
<td>No<br /><span style="color: rgb(237,125,49);">Not used</span></td>
</tr>
</tbody>
</table>

### 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:

```json
"customService": {
    "id": "",
    "title": "Test",
    "asigneeType": "External",
    "email": "testservicepartner@example.com"
  }
```
<table>
<thead>
<tr>
<th>Role</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>customService.id</td>
<td>Service partner id - can be null if would like to create new Service Partner, but email must be set.</td>
<td>No<br />
</td>
</tr>
<tr>
<td>customService.title</td>
<td>Custom service title</td>
<td>No</td>
</tr>
<tr>
<td>customService.asigneeType</td>
<td>Type of service partner - ""Internal"/"External"</td>
<td>Yes<br />
</td>
</tr>
<tr>
<td>customService.email</td>
<td>Service partner e-mail. Use for new service partner when customService.id is not set</td>
<td>Yes<br />
</td>
</tr>
</tbody>
</table>

### 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.

<table>
<thead>
<tr>
<th>Role</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>accidentPlace</td>
<td>Holds the information about the registered accident place for a subrogation case</td>
<td>Yes <br /><span style="color: rgb(237,125,49);">Subrogation</span></td>
</tr>
<tr>
<td>category</td>
<td>Vehicle damage category. Possible values: "other", "collision", "theft", "theftAttempt", "vandalism", "glassDamage", "fallingDust", "fire", "shortCircuit", "totallyDisappeared", "water", "snowPressure", "roadAssistance"</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>year</td>
<td>Vehicle model year</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>vehicleBrand</td>
<td>Vehicle brand</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>registrationNo</td>
<td>Vehicle registration number</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>chassisNo</td>
<td>Vehicle chassis number</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>vehicleModel</td>
<td>Vehicle model</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>vehicleServiceLevel</td>
<td>Specifies the vehicle repair network property (service level). Used together with vehiclePropertyCode to request the matching network properties and to narrow the repair shop search during vehicle repair referral. A single value is expected.</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>vehiclePropertyCode</td>
<td>Specifies the vehicle repair network property code. Used together with vehicleServiceLevel to request the matching network properties and to narrow the repair shop search during vehicle repair referral. A single value is expected.</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>vehicleDamageZones</td>
<td>Vahicle damage zones. Possible values: "front", "rightSideFront", "leftSideFront", "rightSideMiddle", "leftSideMiddle", "rightSideRear", "leftSideRear", "rearSection", "roof", "rearScreen", "frontWindscreen", "compartment", "mechanicalParts", "everywhere", "acessories", "floorpan", "noDamage", "other"</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>vehicleTypeForMotor</td>
<td>Possible values: "regular", "camping", "car", "motorcycle", "trailer", "caravan", "scooter", "other"</td>
<td>No<br /><span style="color: rgb(237,125,49);">Motor</span></td>
</tr>
<tr>
<td>subDamageReason</td>
<td>Possible values: "bikeStolen",
"bikeStolenAndFound",
"bikeVandalism",
"bikeDamageRelatedToTrafic",
"biketransportDamage",
"otherBikeDamage"</td>
<td>No<br /><span style="color: rgb(237,125,49);">Indbo</span></td>
</tr>
</tbody>
</table>

## Appendix B – Damage Types

### HUB Motor Damage types

<table>
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr><td><strong>Damage type code</strong></td><td><strong>Description</strong></td></tr>
<tr><td>ANDET</td><td><br/></td></tr>
<tr><td>ANSVARPERS</td><td><br/></td></tr>
<tr><td>ANSVARTING</td><td><br/></td></tr>
<tr><td>BRAND</td><td><br/></td></tr>
<tr><td>GLASSKADE</td><td><br/></td></tr>
<tr><td>HÆRVÆRK</td><td><br/></td></tr>
<tr><td>KOLLISION</td><td><br/></td></tr>
<tr><td>KORTSLUTNING</td><td><br/></td></tr>
<tr><td>NEDFALD</td><td><br/></td></tr>
<tr><td>RETSHJÆLP</td><td><br/></td></tr>
<tr><td>SNETRYK</td><td><br/></td></tr>
<tr><td>TOTALFORSVUNDET</td><td><br/></td></tr>
<tr><td>TYVERI</td><td><br/></td></tr>
<tr><td>TYVERIFORSØG</td><td><br/></td></tr>
<tr><td>ULYKKE</td><td><br/></td></tr>
<tr><td>VAND</td><td><br/></td></tr>
<tr><td>VEJHJÆLP</td><td><br/></td></tr>
</tbody></table>

### HUB  Property Damage types and subtypes

<table>
<colgroup>
<col>
<col>
</colgroup>
<thead>
<tr>
<th><strong>Damage types</strong></th>
<th><strong>Damage subtypes</strong></th>
</tr>
</thead>
<tbody>
<tr><td>None</td><td><br/></td></tr>
<tr><td>FireDamage</td><td>BuildingFire</td></tr>
<tr><td><br/></td><td>DryBoiling</td></tr>
<tr><td><br/></td><td>Explosion</td></tr>
<tr><td><br/></td><td>Lightning</td></tr>
<tr><td><br/></td><td>ShortCircuit</td></tr>
<tr><td><br/></td><td>Soot</td></tr>
<tr><td><br/></td><td>Tobacco</td></tr>
<tr><td></td><td>ChimneyFire</td></tr>
<tr><td></td><td>Fireworks</td></tr>
<tr><td></td><td>ScorchDamage</td></tr>
<tr><td><br/></td><td>OtherFire</td></tr>
<tr><td>GlassPorcelainDamage</td><td>Bowl</td></tr>
<tr><td><br/></td><td>Glass</td></tr>
<tr><td><br/></td><td>PureGlassDamage</td></tr>
<tr><td><br/></td><td>OtherGlassPorcelain</td></tr>
<tr><td><br/></td><td>GlassInDoorsAndWindows</td></tr>
<tr><td><br/></td><td>GlassInWhitegoodsAndSimilar</td></tr>
<tr><td><br/></td><td>GlassInSolarCellsOrSolarThermal</td></tr>
<tr><td><br/></td><td>GlassInGreenhouse</td></tr>
<tr><td><br/></td><td>CosmeticGlassDamage</td></tr>
<tr><td>PipeDamage</td><td>HiddenPlaces</td></tr>
<tr><td><br/></td><td>ServicePipes</td></tr>
<tr><td><br/></td><td>OtherPipe</td></tr>
<tr><td><br/></td><td>CosmeticPipeLeakage</td></tr>
<tr><td>RotInsectDamage</td><td>DryRot</td></tr>
<tr><td><br/></td><td>Insect</td></tr>
<tr><td><br/></td><td>Rot</td></tr>
<tr><td></td><td>Mold</td></tr>
<tr><td><br/></td><td>OtherRotInsect</td></tr>
<tr><td>StormDamage</td><td>Storm</td></tr>
<tr><td><br/></td><td>StormRain</td></tr>
<tr><td><br/></td><td>OtherStorm</td></tr>
<tr><td>SuddenDamage</td><td>Collision</td></tr>
<tr><td><br/></td><td>SuddenDamage</td></tr>
<tr><td><br/></td><td>OtherSudden</td></tr>
<tr><td><br/></td><td>CosmeticDamage</td></tr>
<tr><td>TheftVandalismDamage</td><td>Theft</td></tr>
<tr><td><br/></td><td>Vandalism</td></tr>
<tr><td><br/></td><td>Frost</td></tr>
<tr><td><br/></td><td>OtherTheftVandalism</td></tr>
<tr><td>WaterDamage</td><td>InteriorPipes</td></tr>
<tr><td><br/></td><td>Leakage</td></tr>
<tr><td><br/></td><td>LeakingWater</td></tr>
<tr><td><br/></td><td>Rain</td></tr>
<tr><td><br/></td><td>Snow</td></tr>
<tr><td><br/></td><td>Thaw</td></tr>
<tr><td></td><td>WaterDamage</td></tr>
<tr><td><br/></td><td>OtherWater</td></tr>
<tr><td><br/></td><td>ExtendedWaterDamageCoverage</td></tr>
<tr><td>Other</td><td>OtherOther</td></tr>
<tr><td>DamageCausedByAnimals</td><td>DamageCausedByAnimals</td></tr>
<tr><td></td><td>OtherDamageCausedByAnimals</td></tr>
<tr><td>Hail</td><td>Hail</td></tr>
<tr><td></td><td>OtherHail</td></tr>
<tr><td>WeatherCondition</td><td>OtherWeatherCondition</td></tr>
<tr><td>Unknown</td><td>OtherUnknown</td></tr>
</tbody>
</table>

### Appendix C – Vehicle damage areas

| Damage areas         |
| -------------------- |
| Bagparti             |
| Bagrude              |
| Forrude              |
| Front                |
| Højre side bagest    |
| Højre side forrest   |
| Højre side midtfor   |
| Kabine               |
| Mekaniske dele       |
| Overalt              |
| Tag                  |
| Tilbehør             |
| Undervogn            |
| Venstre side bagest  |
| Venstre side forrest |
| Venstre side midtfor |

### Appendix D – Building sectors

| Secret code       |
| ----------------- |
| AGRICULTURE       |
| CHANGEOFOWNERSHIP |
| COMMERCIAL        |
| CONTENTCOMMERCIAL |
| CONTENTPRIVATE    |
| ENTERPRISE        |
| GOVERNMENT        |
| HOLIDAYHOME       |
| OTHER             |
| PRIVATE           |
| RISKASSESSMENT    |

### Appendix D.1 – Health sectors

| Secret code |
| ----------- |
| COMMERCIAL  |
| PRIVATE     |

### 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.

<table>
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th>JSON path</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>title</td>
<td>Header for the whole content section</td>
<td>No</td>
</tr>
<tr>
<td>properties</td>
<td>Object or array</td>
<td>Yes</td>
</tr>
<tr>
<td>properties[].title</td>
<td>Display name of field</td>
<td>Yes</td>
</tr>
<tr>
<td>properties[].value</td>
<td>Value of field</td>
<td>Yes</td>
</tr>
<tr>
<td>properties[].formattedValue</td>
<td>Overrides properties[].value when displaying</td>
<td>No</td>
</tr>
</tbody>
</table>

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

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

Examples:

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

```json
{
  "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).

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

### Appendix H - Loss(damage) coverages

| Coverage         |
| ---------------- |
| Undefined        |
| Covered          |
| NotCovered       |
| PartiallyCovered |
| Undertermined    |
| BelowDeductible  |

### 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

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

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

### Appendix J - Case Create request payload examples

* [Building](/examples/uni/CreateGenericCaseRequest.buildingClaim.example.json)  case create example
* [Content](/examples/uni/CreateGenericCaseRequest.contentClaim.example.json)  case create example