Skip to Main Content
Riverty Docs
    riverty logo Docs

    Get the Reference Contacts for a Claim

    Path

    GET /claims/{claimNumber}/referenceContacts

    Request Parameters

    X-Client-Global-Id
    number
    Client Global Id header. Used for internal communication only
    X-Client-Reference
    array
    Client reference header. Used for internal communication only
    claimNumber
    required
    string
    claim number of the requested claim
    page
    integer default: 1
    The current page number.
    pageSize
    integer default: 10
    The number of items per page.

    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.
      identificationNumber
      string
      Max length: 128
      This is the social security number of the referenceContact or company registration number, when the referenceContact is a company.
      legalEntityType
      string
      Enum:
      • NATURAL_PERSON
      • SOLE_PROPRIETORSHIP
      • COMPANY
      Represents the legal entity type of a referenceContact. NATURAL_PERSON for private individuals, SOLE_PROPRIETORSHIP for single-person companies, and COMPANY for incorporated companies and other business entities.
      object
      An address of a contact or customer.
      street
      string
      Max length: 128
      street or adresse line 1. The street could include the house number, but if possible please provide the house number as separate value in the field houseNumber
      houseNumber
      string
      Max length: 10
      The street / address line 1
      addressLine2
      string
      Max length: 128
      addressLine2, can be used, for example, for an additional address indication
      zipCode
      string
      Max length: 10
      The zip code.
      city
      string
      Max length: 40
      The city.
      countryCode
      string
      Max length: 2
      The country code according to ISO 3166-1 alpha 2.
      careOf
      string
      Max length: 128
      An optional contact person.
      array
      List of contact channeles of the contact.
      type
      string
      Enum:
      • PHONE
      • MOBILE_PHONE
      • EMAIL
      value
      string
      Max length: 120
      the contact information for person or company
      object
      Pagination information for the response.
      totalItems
      required
      integer
      The total number of items available.
      pageSize
      required
      integer
      The number of items per page.
      currentPage
      required
      integer
      The current page number.
      totalPages
      required
      integer
      The total number of pages.
    • 401 request not authorized
    • 404 claim not found
    Successful Request

    Request Example

        
        null

    Response Example

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