Get a Claim

Path

GET /claims/{claimNumber}

Request Parameters

X-Client-Reference

array

Client reference header

claimNumber

required

string

Refers to an existing claim

Responses

clientNumber

string

claimNumber

string

object

Contains all the customer data. Multiple customers can be provided.

customerNumber

string

Max length: 40

This is the identifier of the customer. Provided by the client.

clientId

string

Max length: 16

This is the identifier of the client. If a client has multiple business lines, this field can be used for the separation of business lines.

identificationNumber

string

Max length: 128

This is the social security number of the customer or company registration number, when the customer is a company.

title

string

Max length: 32

This is the title of the customer. It will likely be used in mails or letters.

gender

string

Max length: 20

This is the gender of the customer. * `MALE` - The customer's gender is male. * `FEMALE` - The customer's gender is female. * `DIVERSE` - The customer's gender is diverse. * `null` - The customer's gender is unknown.

firstName

string

Max length: 128

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

lastName

string

Max length: 256

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

companyName

string

Max length: 256

This is the company name of the customer, separated by either dashes or spaces.

dateOfBirth

string

yyyy-MM-dd

Max length: 10

This is the date of birth of the customer. It is needed for legal checks, eg. is the customer underaged.

type

string

Max length: 20

Represents the type of a customer. * `PRIVATE` - The customer is a private individual. * `COMPANY` - The customer is a company.

preferredLanguage

string

Max length: 2

This is the language in which the customer wants to be contacted, according to ISO 3166-1 alpha 2.

dateOfDeath

string

yyyy-MM-dd

Max length: 10

This is the date of death of the customer.

array

These are the addresses of the customer and his/her further contact persons.

array

List of contact channels of the customer.

array

List of bank accounts of the customer

object

holds the information for an installment, if there is an installment agreement

object

array

A set of actions than can be executed on the claim

Successful Request

Request Example

    
        null

Response Example

    
        {
 "clientNumber": "1856836920",
 "claimNumber": "731770919",
 "customer": {
  "customerNumber": "K2103621188",
  "clientId": "Herman, Hagenes and Huels",
  "identificationNumber": "3v142uynrjYBazA8JGVmHsipfbM",
  "gender": "FEMALE",
  "firstName": "Lizzie",
  "lastName": "Medhurst",
  "dateOfBirth": "1971-12-26",
  "type": "PRIVATE",
  "addresses": [
   {
    "street": "814 Jabari Trace",
    "zipCode": "05450-4204",
    "city": "Hoppeview",
    "countryCode": "PL",
    "careOf": "Kimberly Satterfield",
    "type": "SHIPPING"
   },
   {
    "street": "32578 Johnpaul Camp",
    "zipCode": "30134",
    "city": "Reichelfort",
    "countryCode": "DZ",
    "careOf": "Gerda Runolfsdottir",
    "type": "SHIPPING"
   },
   {
    "street": "798 Brakus Park",
    "zipCode": "76080-8187",
    "city": "Port Keenanmouth",
    "countryCode": "PY",
    "careOf": "Alverta Bergnaum",
    "type": "BILLING"
   },
   {
    "street": "7411 Block Views",
    "zipCode": "48445-7567",
    "city": "Kilbackview",
    "countryCode": "BB",
    "careOf": "Abelardo Volkman",
    "type": "BILLING"
   }
  ],
  "communicationChannels": [
   {
    "type": "PHONE",
    "value": "1-252-475-2673 x02889",
    "additionalProperties": {}
   },
   {
    "type": "PHONE",
    "value": "1-410-281-3933",
    "additionalProperties": {}
   },
   {
    "type": "EMAIL",
    "value": "Bryon_Kiehn@gmail.com",
    "additionalProperties": {}
   }
  ],
  "bankAccounts": [
   {
    "iban": "GB95PBVB00318802489004",
    "additionalProperties": {}
   },
   {
    "iban": "CH941962703J0475Q3922",
    "additionalProperties": {}
   }
  ]
 },
 "availableActions": [],
 "additionalProperties": {}
}