3.13. partyStructure

General properties

In many customer folders, the party is located in the center of a web of contracts around it, varying from pensions to policies and even telephone companies or energy contracts, often with explicit relationships to other parties in the database. A party may be a (natural) person or an organization.

In the partyStructure, the party entity is the central point of focus. Within SIVI AFS it is not allowed to nest structures under structures. However, sometimes it is required – particularly in case of an extensive customer folder – to fully document for example a policy (policyStructure), a mortgage (loanStructure) or process appointments (ticketStructure). If these structures are saved anywhere in the database already, it is relatively simple to refer to these structures by using the ref-attributes in SIVI AFS: i.e. you can use the policyRef attribute to refer to the refKey (a technical ID) of one or more policy entities.

The main party of a customer folder can have a series of related parties such as a partner, children, parents and employer. These connections can be modeled with the entityType ‘relation’.

Mandatory components

The table below contains the mandatory entities and attributes of the partyStructure. Please note: these are only the mandatory components; in this case only the presence of a party entity. In many functions and messages, the message will be more extensive, including (nested) policy, object and coverage entities, and often a commonFunctional entity. See later in this section for a more detailed example. More information about functions related to party is available in chapter Domain specific functions under Party.

See AFD 2.0 Online for the complete and up-to-date data catalog with all entities, entityTypes and attributes, associated with the partyStructure. More documentation on the use of SIVI AFS is available in chapter Where to find elements of SIVI AFS. A general description of AFD structures is provided in the introduction to AFD structures, while information on details of AFD structures is available in chapter Where to find details about AFD structures.

JSON example

Below is an example of a partyStructure, including a commonFunctional entity and an attachment. Note that at the top level within JSON, the partyStructure entity is not explicitly mentioned. In XML, the structure is always explicitly defined (as partyStructure) at the highest level as well.

{
	"commonFunctional": [ {
		"entityType": "default",
		"function": "17",
		"dataCatalogVersion": "36D"
	} ],
	"party": [ {
		"entityType": "policyHolder",
		"refKey": "jdvries219842109",
		"surname": "De Vries",
		"firstName": "Janna",
		"country": "NL",
		"gender": "V",
		"email": "j.de.vries@hotmail.com"
	} ],
	"document": [ {
		"entityType": "default",
		"sequenceNumber": 1
	} ]
}