Introduction
- Overview
Authentication
Endpoints
Case Data
- Get Case Data Request
- Get Case Data Response
[Appendix A – Case data elements description](#appendix a case data elements description)
- Root
- Case
- Termination
- Policy
- Customer
- Contacts
- Loss
- Participants
- Jobs/services
Appendix B – Damage Types
- HUB Property Damage types and subtypes
Appendix C – Property sectors
Appendix D - Job types and service statuses
Appendix E – External references
- Country codes
- Date/time format
Appendix F - Standard case states
Appendix G - Case Data Response buildingClaim example
Appendix H - Case Data Response contentClaim example

This document describes the Scalepoint Case Data API. This API can be used to get case data from Scalepoint CORE, HUB and ClaimShop.

Main consumer of this API is insurance company.

Overview

The process of obtaining case data can be divided into two steps:

Authentication
Get case data

Websequence diagram of Get Case Data Request

Authentication

You need an access_token in order to send data to the Case Data Endpoint. This access token can be obtained from the Authentication Endpoint. Please refer to the documentation about details of authentication process.

API caller should request "platform-case:read" scope from Authentication Endpoint.

Endpoints

Authentication endpoint

For authentication Scalepoint provides two endpoints – one for production and one for everything else.

Production endpoint:

https://accounts.scalepoint.com/connect/token

Non-production endpoint:

https://sandbox-accounts.scalepoint.com/connect/token

Case Data API main endpoint

The endpoint which allows to obtain any case by its token is in the following format:

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

Here is case token (returned by Case Integration API) which uniquely identifies case across all Scalepoint products.

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/data/v1/dk/abcinsurance/case/b.d1a72df4-f7d5-402c-a495-cc31b8b39a59

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/data/v1/dk/abcinsurance/case/b.d1a72df4-f7d5-402c-a495-cc31b8b39a59

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

Case Data API main endpoint by number

In case if caller has no case token, another endpoint can be used which allows to obtain case by its number:

https://www.scalepoint.com/api/integration/data/<version>/<country>/<tenant>/<caseType>/<caseNumber>

When this endpoint is used, caller needs to provide case type explicitly since it cannot be extracted from case number. Allowed case types are described in [Appendix A](#Appendix A Case data elements description).

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/data/v1/dk/abcinsurance/buildingClaim/CN42042

Additional case data endpoints

Not all of case data is returned by main endpoint. Some of case data parts are too big to always return them, so the idea is to provide access to them in form of additional, "child" endpoints. For example, here is the endpoint which could've been implemented to return case messages:

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

And the specific endpoint could look something like this:

https://www.scalepoint.com/api/integration/data/v1/dk/abcinsurance/case/b.d1a72df4-f7d5-402c-a495-cc31b8b39a59/messages

Currently, the following additional case data endpoints are available:

Get Attachment by Token

This endpoint allows you to retrieve a specific attachment by case token and attachment ID:

https://www.scalepoint.com/api/integration/data/<version>/<country>/<tenant>/case/<caseToken>/attachment/<attachmentId>

The specific endpoint could look something like this:

https://www.scalepoint.com/api/integration/data/v1/dk/abcinsurance/case/b.d1a72df4-f7d5-402c-a495-cc31b8b39a59/attachment/03f37a91-3e6f-46a7-bea4-78d653b5c949

Get Attachment by Case Number

This endpoint allows you to retrieve a specific attachment by case number and attachment ID:

https://www.scalepoint.com/api/integration/data/<version>/<country>/<tenant>/case/<caseType>/<caseNumber>/attachment/<attachmentId>

The specific endpoint could look something like this:

https://www.scalepoint.com/api/integration/data/v1/dk/abcinsurance/case/buildingClaim/CN42042/attachment/03f37a91-3e6f-46a7-bea4-78d653b5c949

Both attachment endpoints return the binary content of the attachment file with appropriate content-type headers.

List Attachments by Token

This endpoint allows you to retrieve the list of all attachments for a case identified by its token:

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

The specific endpoint could look something like this:

https://www.scalepoint.com/api/integration/data/v1/dk/abcinsurance/case/b.d1a72df4-f7d5-402c-a495-cc31b8b39a59/attachments

List Attachments by Case Number

This endpoint allows you to retrieve the list of all attachments for a case identified by its case number:

https://www.scalepoint.com/api/integration/data/<version>/<country>/<tenant>/<caseNumber>/attachments

The specific endpoint could look something like this:

https://www.scalepoint.com/api/integration/data/v1/dk/abcinsurance/CN42042/attachments

Both list attachments endpoints return HTTP 200 OK with Content-Type: application/json. The response body is a JSON array of attachment objects. Each object includes all attachment fields except the binary file content.

Response fields

Field	Type	Required	Description
`id`	string (UUID)	Yes	Unique identifier for the attachment
`fileName`	string	Yes	Name of the file
`fileSize`	integer	Yes	Size of the file in bytes
`description`	string	No	Description of the attachment
`isRestricted`	boolean	No	Indicates if the attachment is restricted
`creationDate`	datetime	No	Creation date

Example response

[
  {
    "id": "03f37a91-3e6f-46a7-bea4-78d653b5c949",
	"creationDate": "2026-01-09T07:41:51.4520954",
    "fileName": "damage-photo.jpg",
    "fileSize": 204800,
    "description": "Photo of the damaged area",
    "isRestricted": false
  },
  {
    "id": "8ac4852d-3e5f-4ed3-9f8b-014748881739",
	"creationDate": "2026-01-09T07:41:51.4520954",
    "fileName": "invoice.pdf",
    "fileSize": 51200,
    "description": null,
    "isRestricted": true
  }
]

Case Data

Get Case Data Request

Case data GET request contains request parameters as a part of in endpoint URL (see above) and authorization header.

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

Bearer access_token

Note the important space character between Bearer and access_token value.

Get Case Data Response

Case data GET response contains case fields in JSON format in case of success (HTTP status code 200). Fields are described in [Appendix A](#Appendix A Case data elements description).

Response JSON schema and examples can be found in [Appendix G](#Appendix G Case Data Response buildingClaim example), [Appendix H](#Appendix H Case Data Response contentClaim example).

Simplest successful response example:

{
  "token": "b.d1a72df4-f7d5-402c-a495-cc31b8b39a59",
  "tenant": "abcinsurance",
  "country": "dk",
  "caseType": "buildingClaim",
  "caseNumber": "CN42042",
  "policy": {
    "number": "4405.09228"
  }
}

In case of error response JSON can be ignored - instead HTTP status code should be used to determine error type.

Appendix A Case data elements description

Root

JSON Path	Description	Required
`token`	Case token which uniquely identifies case across all Scalepoint products.	Yes
`url`	Public URL to case in Scalepoint application.	No
`tenant`	The tenant will be a value given to the company and will normally be the same as the company name. This isn't used to specify a relationship between a claim and a company, but rather to distinguish one company from another.	Yes
`company`	One or more company values will be assigned by Scalepoint to support your company/brands. For example if company is "ABC insurance" they may be assigned the company key: "abcinsurance" to indicate this company. If "ABC insurance" also have another brand: "Budget Insurance", this might be assigned the company key: "budget" or "budgetinsurance".	No
`country`	Since a company may be operating in several countries, using the same brand, we need the country value to distinguish. For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. For example, to specify Denmark, one would use "dk".	Yes
`caseType`	The caseType determines the kind of case you are retrieving. Supported values are: "buildingClaim", " buildingRiskAssessment", "contentClaim", "contentItemization", "motorClaim" and "privateMedicalInsuranceClaim".	Yes
`caseNumber`	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. The combination of: tenant+company+country+caseType+caseNumber must be unique. If any one of these differ, it will be a new case.	Yes
`publicId`	Case unique identifier used in other Scalepoint Public APIs. The combination of: caseType+publicId must be unique.	No HUB Property, HUB Health
`relatedCaseNumbers`	If other cases are related to the case, being integrated, a list of caseNumbers can be specified to indicate the relationship.	No HUB Property, HUB Health optional
`isUrgent`	This parameter can be used to indicate if a case is urgent.	No HUB Property, HUB Health optional
`firstNotificationDate`	This is used to indicate the first time, when the case was notified (e.g. by a claimant using a self-service registration service). Date/time format should follow ISO-8601.	No HUB Property, HUB Health (Optional)
`accidentDate`	This is used to indicate the date (and optionally time) when the accident/loss occurred. Date/time format should follow ISO-8601.	No HUB Motor, HUB Property, ClaimShop HUB Health (Date of first symptom)
`reserve`	Locked amount on insurance account for the claim	No HUB Motor, HUB Property, ClaimShop
`settlementType`	The parameter indicates the type of the settlement. Possible options: none, withRepair, withoutRepair	No HUB motor, HUB Property, ClaimShop
`claimantSuggestion`	The parameter indicates the claimant repair handling type. Possible options: none, no, ownCraftsman, cashCompensation	No HUB Motor, HUB Property, ClaimShop
`itemizationCaseReference`	Unique identifier that links SelfService case with ClaimShop case	No ClaimShop
`selfServiceLink`	Public URL to case in SelfService application.	No ClaimShop
`claimShopCaseLink`	URL to case in Scalepoint application for claim handler.	No ClaimShop

Case

JSON Path	Description	Required
`state`	Case state
`closingDate`	Date when case is closed
	Additional fields available for current case (depending on case type) will be added here inline

Termination

JSON Path	Description	Required
`isTerminated`	Indicates if a claim is terminated
`terminationReason`	Provides a termination reason. Possible options: none notCovered belowDeductible createdByMistake other phoneInspection notCoveredAfterInspection paidInOwnSystem inactivity customReason

Policy

JSON Path	Description	Required
`policy.number`	Policy number.	Yes HUB Motor, HUB Property, ClaimShop, HUB Health (required)
`policy.policyHolder.isDataProtected`	Determines if policy holders contain protected data.	No HUB only
`policy.policyHolder.name`	Name of the policy holder. This can be the name of a person or the name of a company.	No HUB Health optional
`policy.policyHolder.commercialTaxId`	The commercial tax id is can be used if policy holder is describing a company.	No HUB Health optional
`policy.productName`	Policy product name describes a policy product for which a certain set of depreciation rules apply in a human-readable way. Used for presentation only. Examples: "Private household basic", "Commercial plus".	No HUB Property only
`policy.conditions`	Conditions that apply to the policy.	No HUB Property only
`policy.vatSharePercentage`	VAT share percentage is used in cases where a Property is partly private and partly commercial. The VAT share percentage can be specified to indicate how much of the Property is commercial.	No HUB Property only
`policy.customerRating`	Customer rating values can be passed here. It can be a system of "red", "yellow" and "green" (for ECC) or anything (for HUB Property). In order to build logic on top of this, it should be consistent.	No HUB Property, ClaimShop
`policy.specialCoverage`	If there is any special special coverage on the policy, it can be specified with this parameter. The field is a freetext field.	No HUB Property, HUB Health optional
`policy.clauses`	Clauses that apply to the policy can be specified with this parameter. The field is a freetext field.	No HUB Property, HUB Health optional
`policy.policyCoverageId`	Id of the policy coverage picked on the claim. It comes from `policy.lines[].coverages[].coverageId` sent at case creation. It is empty if your policy data has no coverage ids, or if the claim was created before ids were stored.	No HUB Property, HUB Health optional

Customer

JSON Path	Description	Required
`customer.isDataProtected`	Determines if customer contains protected data.	No HUB only
`customer.name`	Name of the customer.	No HUB Health required
`customer.email`	Email address of the customer.	No HUB Health optional
`customer.phone`	Phone number of the customer.	No HUB Health optional
`customer.mobile`	A mobile phone number of the customer. This should be given without any special punctuation, except for spaces. Examples: "12 34 56 78", "12345678"	No HUB Health optional
`customer.comment`	Remark or comment about the customer	No HUB Property, HUB Health optional
`customer.address.street1`	Street of customers address.	No HUB Health required
`customer.address.street2`	Additional street information.	No
`customer.address.postalCode`	Postal / zip code of the customers address.	No HUB Health required
`customer.address.city`	City of the customers address.	No HUB Health required
`customer.address.country`	Country of the customers address. For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. For example, to specify Denmark, one would use "dk".	No
`customer.personalTaxId`	This is the customers social security number. Only used in Denmark (CPR number). Should be specified as 10 digits with no punctuation.	No ClaimShop, HUB Health optional
`customer.customerNo`	List of customer numbers for the customer (claimant). These are identifiers assigned by the insurance company to the insured person. Returns an array of strings; filtered to the subcompany of the current case.	No

Contacts

For the moment only HUB Property supports contacts. The details of the contact are same to those of "customer" element and will not be described again in details.

JSON Path	Description	Required
`contacts[]`	List of contacts. Each contact has list of fields same as "customer"	No HUB Property, HUB Health optional

Loss

JSON Path	Description	Required
`loss.type`	Used to describe the type of loss or damage. Specific values apply to different applications. Please see [Appendix B – Damage Types](#Appendix B Damage Types) for a list of possible values.	No HUB motor, HUB Property
`loss.subType`	Used to further describe the loss or damage. Please see [Appendix B – Damage Types](#Appendix B Damage Types) for a list of possible values.	No HUB Property only
`loss.description`	Description of the damage or loss.	No HUB motor, HUB Property, HUB Health optional
`loss.coverage`	Damage coverage. Possible options: undefined covered notCovered partiallyCovered undertermined belowDeductible	No HUB motor, HUB Property, ClaimShop

Deductible

JSON Path	Description	Required
`loss.deductible.value`	The deductible is the amount of expenses that must be paid by the policy holder.	No HUB Property, ClaimShop, HUB Health optional
`loss.deductible.comment`	Deductible comment. 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.	No HUB Property only
`loss.deductible.policy.imported`	If policy deductible is used then imported deductible is returned.	No HUB Property only
`loss.deductible.conditional.original`	If conditional deductible is used then deductible for single damaged item is returned.	No HUB Property only
`loss.deductible.conditional.itemCount`	If conditional deductible is used then count of damaged items is returned.	No HUB Property only
`loss.deductible.conditional.modifier`	If conditional deductible is used then subtraction/addition to the resulting deductible is returned.	No HUB Property only
`loss.deductible.percentage.percent`	If percentage deductible is used then deductible percent is returned as a number between 0 and 100.	No HUB Property only
`loss.deductible.percentage.minValue`	If percentage deductible is used then a minimum deductible value is returned (optional).	No HUB Property only
`loss.deductible.percentage.maxValue`	If percentage deductible is used then a maximum deductible value is returned (optional).	No HUB Property only

Depreciation

JSON Path	Description	Required
`loss.depreciation.value`	Total case depreciation amount to be paid by customer.	No
`loss.depreciation.nonServiceDepreciation`	Non-service part of case depreciation amount - i.e. not included into "jobs[].services[].depreciation".	No

Regress

JSON Path	Description	Required
`loss.regress.value`	Describes if loss has regress. Optional - "loss.regress" is omitted when information wasn't provided. Supported values are: "yes", "no", "unknown".	No
`loss.regress.details`	Additional regress details.	No

Property

JSON Path	Description	Required
`loss.building.sector`	Sector is a code, which can be any one of the ones defined in [Appendix C – Property sectors](#Appendix C Property sectors) – Property sectors.	No HUB Property only
`loss.building.address.street1`	Street of building address. HUB Health: Building.address is Primary Address, used when finding closest service provider.	No HUB Property only
`loss.building.address.street2`	Additional Property information.	No HUB Property only
`loss.building.address.postalCode`	Postal / zip code of the Property address.	No HUB Property only
`loss.building.address.city`	City of the Property address.	No HUB Property only
`loss.building.address.country`	Country of the customers address. For country codes, Scalepoint uses values as defined by ISO 3166-1 alpha-2, albeit in lowercase. For exammple, to specify Denmark, one would use "dk".	No
`loss.building.buildingYear`	Building year indicates the year the building was completed. Should be in the format "yyyy" (e.g. "1965" or "2000").	No HUB Property only
`loss.building.livingArea`	Indicates the amount of space of the building which is living area (e.g. "200 m2"). This is a string value and as such there are no specific format to be used.	No HUB Property only
`loss.Property.basementArea`	Indicates the amount of space of the building which is basement area (e.g. "75 m2"). This is a string value and as such there are no specific format to be used.	No HUB Property only
`loss.building.garageOutbuildingArea`	Indicates the amount of space which is occupied by a garage or other outdoor building areas (e.g. "50 m2"). This is a string value and as such there are no specific format to be used.	No HUB Property only
`loss.building.roofType`	This can be use to specify the type of roof on the building. This is a string value and as such there are no specific format to be used.	No HUB Property only
`loss.building.timber`	Use to indicate if the Property is a timber framing building (danish: bindingsværk). Supported values: "true" or "false".	No HUB Property only
`loss.building.conditionReport`	Use this to indicate whether a condition report for the building exists. Supported values: "true" or "false".	No HUB Property only

Content

JSON Path	Description	Required
`loss.content.items`	List of content items	No ClaimShop only
`loss.content.groups`	List of content item groups	No ClaimShop only

Content Items

JSON Path	Description	Required
`loss.content.items[].category`	Category of the content item	Yes
`loss.content.items[].subCategory`	Sub category of the content item	No
`loss.content.items[].description`	Description of the content item	Yes
`loss.content.items[].itemId`	Identifier of the content item	Yes
`loss.content.items[].uiItemId`	Claim item id on UI	No
`loss.content.items[].depreciationPercentage`	Depreciation of the content item (%)	Yes
`loss.content.items[].depreciationAmount`	Depreciation amount of the content item	No
`loss.content.items[].quantity`	Quanity of the content item	Yes
`loss.content.items[].replacementAmount`	Replacement amount of the content item	Yes
`loss.content.items[].ageMonths`	age of the content item (in months)	No
`loss.content.items[].basePrice`	The price basing on which replacement was implemented	No
`loss.content.items[].group`	Group of the content item	No
`loss.content.items[].createType`	shows how line was created. If claim handler created a line, then it is manual, otherwise it was imported. e.g: MANUAL, FNOL, SELFSERVICE, EXCEL, EXCEL_EXTERNAL_	Yes
`loss.content.items[].lossType`	DAMAGED, STOLEN	No
`loss.content.items[].draft`	draft item is not to be settled	Yes
`loss.content.items[].rejected`	Item can be rejected by claim handler	No
`loss.content.items[].valuations`	The item can have different valuations such as customer demand, new price, etc.	No
`loss.content.items[].valuations.price`		Yes
`loss.content.items[].valuations.active`	Active means that this valuation price is chosen to be settled. Only one valuation can be active	Yes
`loss.content.items[].valuations.type`	e.g.: PURCHASE_PRICE, CUSTOMER_DEMAND, NEW_PRICE, USED_PRICE, CATALOG_PRICE, RETAIL_PRICE, REPAIR_PRICE, DISCRETIONARY_VALUATION, REPAIR_ESTIMATE_	Yes
`loss.content.items[].group.$ref`	Group object reference id	Yes
`loss.content.items[].product`	Product match of the content item	No
`loss.content.items[].product.brand`	Brand of a product matched to the item	Yes
`loss.content.items[].product.catalogCategory`	Catalog category of a product matched to the item	Yes
`loss.content.items[].product.code`	Code of a product matched to the item	Yes
`loss.content.items[].product.retailPrice`	Retail price of a product matched to the item	Yes
`loss.content.items[].product.scalepointPrice`	Scalepoint price of a product matched to the item	Yes
`loss.content.items[].voucher`	Voucher replacement for content item	No
`loss.content.items[].voucher.voucherCode`	Code of a voucher replacement for content item	Yes
`loss.content.items[].voucher.faceValue`	Face value of a voucher replacement for content item	Yes
`loss.content.items[].voucher.voucherBasePrice`	The price basing of which a voucher price is calculated	Yes
`loss.content.items[].haveNoDocumentation`	Customer doesn't have documentation	Yes
`loss.content.items[].haveDocumentationThatICanNotAdd`	Customer has documentation but cannot add it to claim	Yes
`loss.content.items[].numberOfDocumentationFilesAddedToLine`	Number of attachments added by customer	Yes

Content Groups

JSON Path	Description	Required
`loss.content.groups[].$id`	JSON object refernce id	Yes
`loss.content.groups[].id`	Identifier of the group	Yes
`loss.content.groups[].valuationAmount`	Amount of the group	Yes
`loss.content.groups[].name`	Name of the group	Yes
`loss.content.groups[].type`	Type of the group. possible values are "OVERVIEW","VALUATION", "VOUCHER"	Yes

Participants

JSON Path	Description	Required
`participants[]`	List of all case participants.	No
`participants[].id`	ID of the participant unique in scope of current case. Used to reference participant from other parts of JSON document.	Yes
`participants[].name`	Display name of the case participant.	Yes
`participants[].type`	Type of the case participant. Supported values are: "person", "company", "pool", "other".	Yes
`participants[].responsibilities[]`	List of responsibilities of the case participant on a given case. Supported values are: "caseOwner", "reportOwner", "damageInspector", "repairer", "damageService", "riskInspector", "serviceProvider".	Yes
`participants[].isActive`	Boolean flag indicating if case participant is active (true) or inactive (false).	Yes
`participants[].email`	Email address of the case participant.	No
`participants[].phone`	Phone number of the case participant. Can be any string, not formatted. Examples: "12 34 56 78", "+45 33333".	No
`participants[].mobile`	Mobile phone number of the case participant. Can be any string, not formatted. Examples: "12 34 56 78", "+45 33333".	No

Jobs/services

JSON Path	Description	Required
`jobs[]`	List of all case jobs. Jobs are containers for competing case services. Most jobs contain only one service which is not competing with other services.	No
`jobs[].type`	Type of the case job and all the services in it. Supported values are listed in [Appendix D](#Appendix D Job types and service statuses).	Yes
`jobs[].name`	Name of the case job.	No
`jobs[].services[]`	List of services on a given case job. Contains at least one service.	Yes
`jobs[].services[].participantId`	ID of the participant assigned to a service. Matches "participants[].id" field.	Yes
`jobs[].services[].status`	Service status. Reflects current state of a service. Not applicable for some services. Supported values are listed in Appendix D. They depend on parent job type.	No
`jobs[].services[].depreciation`	Depreciation amount related to given service. Applicable to some repair services only.	No
`jobs[].services[].`	Additional fields available for service (depending on service type) will be added here inline

Appendix B Damage Types

HUB Property Damage types and subtypes

Damage types	Damage subtypes
`None`
`FireDamage`	BuildingFire
	DryBoiling
	Explosion
	Lightning
	ShortCircuit
	Soot
	Tobacco
	ChimneyFire
	Fireworks
	ScorchDamage
	OtherFire
`GlassPorcelainDamage`	Bowl
	Glass
	PureGlassDamage
	OtherGlassPorcelain
	GlassInDoorsAndWindows
	GlassInWhitegoodsAndSimilar
	GlassInSolarCellsOrSolarThermal
	GlassInGreenhouse
	CosmeticGlassDamage
`PipeDamage`	HiddenPlaces
	ServicePipes
	OtherPipe
	CosmeticPipeLeakage
`RotInsectDamage`	DryRot
	Insect
	Rot
	Mold
	OtherRotInsect
`StormDamage`	Storm
	StormRain
	OtherStorm
`SuddenDamage`	Collision
	SuddenDamage
	OtherSudden
	CosmeticDamage
`TheftVandalismDamage`	Theft
	Vandalism
	Frost
	OtherTheftVandalism
`WaterDamage`	InteriorPipes
	Leakage
	LeakingWater
	Rain
	Snow
	Thaw
	WaterDamage
	OtherWater
	ExtendedWaterDamageCoverage
`Other`	OtherOther
DamagHUB motorusedByAnimals	DamagHUB motorusedByAnimals
	OtherDamagHUB motorusedByAnimals
`Hail`	Hail
	OtherHail
`Weather`	OtherWeatherCondition
`Unknown`	OtherUnknown

Appendix C Property sectors

Sector code
`AGRO`
`CHANGEOFOWNERSHIP`
`COMMERCIAL`
`CONTENTCOMMERCIAL`
`CONTENTPRIVATE`
`ENTERPRISE`
`GOVERNMENT`
`HOLIDAYHOME`
`OTHER`
`PRIVATE`
`RISKASSESSMENT`

Appendix D Job types and service statuses

Job types	Service statuses
`customCraftsman`	estimation
	costApproval
	repair
	settlement
	completed
	canceled
`customServiceProvider`	n/a
`damageStop`	requested
	ongoing
	awaitingEvaluation
	approved
	completed
	canceled
`inspection`	requested
	completed
	canceled
`plain`	n/a
`repair`	estimation
	costApproval
	repair
	completed
	canceled
`riskAssessment`	requested
	inspection
	completed
	canceled
`unrelated`	n/a

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

Supported

Appendix F Standard case states

State names might be overriden depending on case type

state
`creation`
`inspection`
`estimation`
`costApproval`
`repair`
`settlement`
`closed`

Appendix G Case Data Response buildingClaim example

{
  "token": "b.54965193-bbfd-4b2d-b06c-a0f14052675f",
  "url":
    "https://www.scalepoint.com/api/integration/dk/abcinsurance/v1/case/b.54965193-bbfd-4b2d-b06c-a0f14052675f",
  "tenant": "abcinsurance",
  "company": "danskeforsikring",
  "country": "dk",
  "caseType": "buildingClaim",
  "caseNumber": "CN41041",
  "publicId": "c639e9f2-c286-4156-aa5c-4ca80e2fea98",
  "relatedCaseNumbers": ["CN62745"],
  "isUrgent": true,
  "reserve": 0,
  "claimantSuggestion": "ownCraftsman",
  "settlementType": "withRepair",
  "firstNotificationDate": "2015-05-15T00:00:00.0000000+02:00",
  "accidentDate": "2015-05-15T00:00:00.0000000+02:00",
  "termination": {
    "isTerminated": false,
    "terminationReason": "none"
  },
  "policy": {
    "number": "71142613",
    "policyHolder": {
      "name": "Test Testensen / Dong Energy A/S",
      "commercialTaxId": "12345678"
    },
    "productName": "Policy product name",
    "productAlias": "Policy product alias",
    "conditions": "R185003",
    "vatSharePercentage": 10,
    "customerRating": "50 / red",
    "specialCoverage": "a text",
    "clauses": "another text",
    "policyCoverageId": "80405795"
  },
  "customer": {
    "name": "Ed Jameson",
    "email": "test@example.com",
    "phone": "12 34 56 78",
    "mobile": "87 65 43 21",
    "comment": "some remarks",
    "personalTaxId": "123456-7890 (CPR)",
    "address": {
      "street1": "Ingemannsvej 9",
      "street2": "",
      "postalCode": "1964",
      "city": "Frederiksberg C",
      "country": "dk"
    }
  },
  "contacts": [
    {
      "name": "Maria Jönsson",
      "phone": "91122850",
      "mobile": "49052996",
      "email": "test@scalepoint.com",
      "comment": "some remarks",
      "address": {
        "street1": "Ingemannsvej 9",
        "street2": "second line",
        "postalCode": "1964",
        "city": "Frederiksberg C",
        "country": "dk"
      }
    }
  ],
  "loss": {
    "type": "FireDamage",
    "subType": "BuildingFire",
    "description": "",
    "coverage": "covered",
    "deductible": {
      "value": 2000,
      "comment": "a text",
      "percentage": {
        "percent": 99,
        "minValue": 1000,
        "maxValue": 2000
      }
    },
    "depreciation": {
      "value": 1500,
      "nonServiceDepreciation": 700
    },
    "regress": {
      "value": "yes",
      "details": "Neighbor's fault!"
    },
    "building": {
      "sector": "commercial",
      "address": {
        "street1": "Ingemannsvej 9",
        "street2": "",
        "postalCode": "1964",
        "city": "Frederiksberg C",
        "country": "dk"
      },
      "buildingYear": "1944",
      "livingArea": "",
      "basementArea": "",
      "garageOutbuildingArea": "",
      "roofType": "",
      "timber": true,
      "conditionReport": true
    }
  },
  "participants": [
    {
      "id": "7",
      "name": "Major Tom",
      "type": "person",
      "responsibilities": [ "caseOwner" ],
      "isActive": true,
      "email": "majort@test.com",
      "phone": "+45 55 55 12 11",
      "mobile": "+45 55 55 13 33"
    },
    {
      "id": "113",
      "name": "Aftsman Co",
      "type": "company",
      "responsibilities": [ "damageInspector", "repairer" ],
      "isActive": true,
      "email": "aftsman@co.dk"
    },
    {
      "id": "3",
      "name": "External Craftsman",
      "type": "company",
      "responsibilities": [],
      "isActive": false
    }
  ],
  "jobs": [
    {
      "type": "inspection",
      "name": "Inspection #1",
      "services": [
        {
          "participantId": "113",
          "status": "completed"
        }
      ]
    },
    {
      "type": "repair",
      "name": "Repair #1",
      "services": [
        {
          "participantId": "113",
          "status": "repair",
          "depreciation": 800
        },
        {
          "participantId": "3",
          "status": "canceled"
        }
      ]
    }
  ]
}

Appendix H Case Data Response contentClaim example

{
  "token":"c.C55478AE-4697-443A-A66C-193B75D96FF4",
  "tenant":"abcinsurance",
  "country":"dk",
  "caseType":"contentClaim",
  "caseNumber":"case123456",
  "itemizationCaseReference": "59395954-3960-4AF6-980E-401A2611271E",
  "selfServiceLink": "http://selfservice.scalepoint.dev/self-service/dk/case/59395954-3960-4AF6-980E-401A2611271E",
  "claimShopCaseLink": "http://www.scalepoint.com/webapp/ScalePoint/dk/webshop/jsp/matching_engine/projects.jsp?caseid=1163&detectActive=yes",
  "policy":{
    "number":"policy09876"
  },
  "customer":{
    "name":"Judy Pearson",
    "address":{
      "street1":"address 1",
      "postalCode":"123 456",
      "city":"Copenhagen"
    }
  },
  "loss":{
    "deductible":{
      "value":300.00
    },
    "content":{
      "items":[
        {
          "category":"Børn",
          "subCategory":"Babyudstyr",
          "subCategoryToken":"66485d5b-5cc7-442d-898a-c0e111374567",
          "description":"Stroller",
          "itemId":"1A44D1F2-CFCA-4DFB-BA6B-3C7903540461",
          "uiItemId":1,
          "depreciationPercentage":15,
          "depreciationAmount":60.00,
          "createType":"MANUAL",
          "draft":false,
          "rejected":false,
          "quantity":1,
          "replacementAmount":340.00,
          "basePrice":400.00,
          "valuations":[
            {
              "price":500.00,
              "active":false,
              "type":"NEW_PRICE"
            },
            {
              "price":420.00,
              "active":false,
              "type":"VOUCHER"
            },
            {
              "price":400.00,
              "active":true,
              "type":"CUSTOMER_DEMAND"
            }
          ],
          "haveNoDocumentation": false,
          "haveDocumentationThatICanNotAdd": false,
          "numberOfDocumentationFilesAddedToLine": 2
        },
        {
          "category":"Telefoni",
          "subCategory":"Mobiltelefoner",
          "subCategoryToken":"1ead932a-185d-11eb-adc1-0242ac120002",
          "description":"Nokia 6600",
          "itemId":"A147D92C-19A5-4EF9-8F9D-60E8F67A3F38",
          "uiItemId":2,
          "depreciationPercentage":0,
          "depreciationAmount":0.00,
          "createType":"FNOL",
          "draft":false,
          "rejected":false,
          "quantity":1,
          "replacementAmount":336.00,
          "basePrice":336.00,
          "valuations":[
            {
              "price":400.00,
              "active":false,
              "type":"NEW_PRICE"
            },
            {
              "price":350.00,
              "active":false,
              "type":"CUSTOMER_DEMAND"
            },
            {
              "price":336.00,
              "active":true,
              "type":"VOUCHER"
            }
          ],
          "voucher":{
            "discount":16.0000000,
            "faceValue":400.00,
            "cashValue":336.00
          },
          "haveNoDocumentation": true,
          "haveDocumentationThatICanNotAdd": false,
          "numberOfDocumentationFilesAddedToLine": 0
        },
        {
          "category":"Briller, Linser \u0026 Hørelse",
          "subCategory":"Solbriller",
          "description":"Ray Ban Original Wayfarer - Unisex",
          "itemId":"9A615DCF-3631-4A4C-B960-95A92AFEAD77",
          "uiItemId":3,
          "depreciationPercentage":0,
          "depreciationAmount":0.00,
          "createType":"SELFSERVICE",
          "draft":false,
          "rejected":false,
          "quantity":1,
          "replacementAmount":1011.00,
          "basePrice":1011.00,
          "valuations":[
            {
              "price":1348.00,
              "active":false,
              "type":"MARKET_PRICE"
            },
            {
              "price":1011.00,
              "active":true,
              "type":"CATALOG_PRICE"
            }
          ],
          "product":{
            "brand":"Ray Ban",
            "catalogCategory":"Solbriller",
            "code":"0rb2140901",
            "retailPrice":1348.00,
            "scalepointPrice":1011.00
          },
          "haveNoDocumentation": false,
          "haveDocumentationThatICanNotAdd": true,
          "numberOfDocumentationFilesAddedToLine": 0
        }
      ]
    }
  }
}

Case Data API

Overview

Authentication

Endpoints

Authentication endpoint

Case Data API main endpoint

Case Data API main endpoint by number

Additional case data endpoints

Get Attachment by Token

Get Attachment by Case Number

List Attachments by Token

List Attachments by Case Number

Response fields

Example response

Case Data

Get Case Data Request

Get Case Data Response

Appendix A Case data elements description

Root

Case

Termination

Policy

Customer

Contacts

Loss

Deductible

Depreciation

Regress

Property

Content

Content Items

Content Groups

Participants

Jobs/services

Appendix B Damage Types

HUB Property Damage types and subtypes

Appendix C Property sectors

Appendix D Job types and service statuses

Appendix E External references

Country codes

Date/time format

Appendix F Standard case states

Appendix G Case Data Response buildingClaim example

Appendix H Case Data Response contentClaim example

On this page