riverty logo

Docs

The Customer Object

A customer is a person or company serviced by our clients. The customer is mandatory for filling a claim. A customer can be either PRIVATE or COMPANY. The relevant attributes depend on the customer’s type.

General Attributes

Attributes Type Description
customerNumber string A unique identifier for the customer.
type enum The type of customer .
enum: PRIVATE, COMPANY
preferredLanguage string The preferred language of the customer.
address object An object containing the customer's address details.
communicationChannels object An object containing various communication channels for the customer.
bankAccounts object An object containing the customer's bank account details.
"customer":  {
        "customerNumber": "B1140280585",
        "gender": "female",
        "title": "Ms.",
        "firstName": "Bianka",
        "lastName": "Hilll",
        "dateOfBirth": "1946-01-01",
        "type": "PRIVATE",
        "addresses": [
            {
                "street": "640 Carrie Crest",
                "zipCode": "56695-0518",
                "city": "West Mattiemouth",
                "countryCode": "TZ",
                "type": "billing"
            }
        ]
    }

Additional Attributes (Private Customer)

Attributes Type Description
IdentificationNumber string The identification number of the customer.
gender string The gender of the customer.
firstName string The first name of the customer.
lastName string The last name of the customer.
dateOfBirth date The date of birth of the customer.
dateOfDeath date The date of death of the customer (if applicable).

Additional Attributes (Company Customer)

Attributes Type Description
companyName string The name of the company.
clientId string The client’s unique identifier.