API Documentation - Version 0.3.0

Addresses

This page contains general notes about addresses.

Address object

An address is a resource object representing an address, for example:


{
  kind: "client",
  id: "GF6YT2"
  company_name: "John Doe Company",
  contact_name: "John Doe",
  street: "John Doe Street",
  street_number: "123",
  country: "DE",
  zip_code: "12345",
  city: "Doe City",
  email: "john.doe@example.org",
  phone_number: "777 123 456"
}

Available types of address

The following types of address (aka kind ) exist in general.

Type	Description
causer	The causer's address
claimant	The claimant's address
client	The client's address
damage_visitable	The address where the damage is visitable.
primary_contractor	The address of the primary contractor.
secondary_contractor	The address of the secondary contractor.

Required types of address and options

Not all types of address are required for each types of claim, except client which is required for all.
The following table lists the required types of address (and their available options) per type of claim.
The type client is not included as it is required for all claims. It also has no options. A client address can only be assigned as object or as ID (see point 1. and 2. below).

Type of claim	Required type of address	Available options for 3.
cooling	causer	none, same_as_client, same_as_insured
	claimant	same_as_client
	client
	damage_visitable	none, same_as_client, same_as_insured
general_forwarding	causer	none, same_as_client, same_as_insured
	claimant	same_as_client
	client
	damage_visitable	none, same_as_client, same_as_insured
	secondary_contractor	none, same_as_insured
goods	causer	none
	client
	damage_visitable	none, same_as_insured
heavy_goods	causer	none, same_as_client, same_as_insured
	claimant	same_as_client
	client
	damage_visitable	none, same_as_client, same_as_insured
	secondary_contractor	none, same_as_insured
relocation	causer	none, same_as_client, same_as_insured
	claimant	same_as_client
	client
	damage_visitable	none, same_as_client, same_as_insured
	primary_contractor	same_as_insured
	secondary_contractor	none, same_as_insured
technical	causer	none, same_as_client, same_as_insured
	claimant	same_as_client
	client
	damage_visitable	none, same_as_client, same_as_insured
traffic_liability	causer	none, same_as_client, same_as_insured
	claimant	same_as_client
	client
	damage_visitable	none, same_as_client, same_as_insured
	secondary_contractor	none, same_as_insured

Assigning an address to a claim

An address (for each required type of address) can be assigned to a claim in three different ways.

1. Passing an address object

Example:


  {
  "client":{"company_name":"John Doe Company","street":"John Doe Street", ...
  }

This creates a new address and assigns it to the client address (type of address client ).

Note that an address is always created in the context of a claim never alone.

The following parameter exist:

Name	Type	Required	Description	Example
company_name	string	Yes	The company name	John Doe Company
contact_name	string	No	The contact person of the company name	Pia Miller
street	string	Yes
street_number	string	Yes
zip_code	string	Yes
city	string	Yes
country	country	Yes	The country code	DE
email	string	No	A contact email address	Pia.Miller@example.org
phone_number	string	No

2. Passing an address ID

This assigns the existing address of given ID to the claim's address kind. Instead of creating address duplicates (in this claims tool, but also in the API client system), an existing address can be reused in this way.

Example:


  { "client":{"id":"GF6YT2"} }

3. Passing a keyword

This does not assign an existing address to the claim's address kind. It assigns a reference to another address in the claim, e.g. the client's address to the claimant. This also reduces address duplicates. If the address is unknown the option none can be used.

Example:


  { "claimant":{"id":"same_as_client"} }

See list above for possible options. Note that there are no options for client . It can only be assigned as object or as ID.

FAQ

How can I assign a new address to a claim?: When a new claim is created submit the address. When an existing claim is updated submit the address. The new one is assigned.
How can I assign a different address to a claim?: An existing claim has client address A and it should be B. If B not exists, submit B with the claim update. (see "1. Passing an address object"). If B exists, submit the ID of the address (see "2. Passing an address ID").
How can I update an existing address (its content)?: This is not supported for now. Update the claim and submit a new address.