Get the Reference Contacts for a Claim

Path

GET /claims/{claimNumber}/referenceContacts

Request Parameters

X-Client-Reference

array

Client reference header

claimNumber

required

string

claim number of the requested claim

Responses

array

firstName

string

Max length: 128

This is for the first name(s) of the contact, separated by either dashes or spaces.

lastName

string

Max length: 256

This is for the last name(s) of the contact, separated by either dashes or spaces.

type

string

Max length: 20

Enum:

SPOUSE

GENERAL_PARTNER

LAWYER

LEGAL_GUARDIAN

MANAGING_DIRECTOR

EMPLOYEE

INSOLVENCY_ADMINISTRATOR

GARNISHEE

BAILIFF

GUARANTOR

The type represents the relationship between contact and custome.

liable

boolean

Max length: 5

This indicates whether a person is liable or not. In this way, non-liable persons such as lawyers or keepers can also be handed over.

object

An address of a contact or customer.

array

List of contact channeles of the contact.

object

Successful Request

Request Example

    
        null

Response Example

    
        {
 "items": [
  {
   "firstName": "string",
   "lastName": "string",
   "type": "SPOUSE",
   "liable": false,
   "address": {
    "street": "string",
    "houseNumber": "string",
    "addressLine2": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "st",
    "careOf": "string",
    "type": "BILLING"
   },
   "communicationChannels": [
    {
     "type": "PHONE",
     "value": "string"
    }
   ]
  }
 ],
 "pagination": {
  "totalItems": 0
 }
}