Search
Related topics are listed below.
Message
Technical functions » Message
*Under construction More detailed information on Message will follow in due time. Messages can be exchanged (in bulk) via a platform, as described in the Message exchange platform section, but they can also be exchanged in a peer-to-peer situation. This chapter…
Message exchange platform
SIVI protocols » Message exchange platform
*Under construction A more thorough description of the Message exchange platform will follow in due time. Introduction The basic goal of a message exchange platform is the secure interchange of structured and unstructured data, as well as documents among trusted…
Mortgage domain mapping
Mapping » Mortgage domain mapping
Based on the article ‘SIVI AFS nu ook geschikt voor modellering hypotheekdomein’ (in SIVI AFS Magazine December 2022). Introduction With the SIVI All Finance Standard (SIVI AFS), it is possible to model the first facets of the mortgage domain. This is the…
messageStructure
AFD structures » messageStructure
General properties A message structure can be considered to be a kind of electronic envelope; it carries information about the sender and receiver on the outside, and a content (letter) on the inside. The envelope/letter can be sent directly to the receiver, or it can…
Introduction to AFD structures
AFD structures » Introduction to AFD structures
Bridge between data catalog and API-framework functions In SIVI AFS, the use of AFD structures occupies a prominent place. In thinking about API architectures, the starting point is that functions are defined on the basis of the specific data set to which the function…
New
Technical functions » Message » New
*Under construction More detailed information on Message will follow in due time. The operation new in case of a message will transmit an electronic message to a party (peer to peer) directly without the need of an intermediary service. How to use variants If you…
Data registration vs services
Domain specific functions » Data registration vs services
Based on the article ‘SIVI AFS: Registratie van gegevens versus services’ (in SIVI AFS Magazine May 2022). Users of SIVI AFS use AFD 2.0 for the performance of services (data exchange) and for registration (data storage). In this article, we show some…
Where to find details about AFD structures
AFD structures » Where to find details about AFD structures
In the Introduction to AFD structures you will find an explanation on structures and baselines in SIVI AFS. Upon request, SIVI uploads baselines to create structures in AOS. Please note that these baselines are only visible in AOS and not downloadable, but if you are…
Initiate
Technical functions » Session » Initiate
*Under construction More detailed information on Session will follow in due time. Request for a url to initiate a browser session with prefilled data. Access to the API and the URLs provided through the API is subject to adequate security measures for…
containerStructure
AFD structures » containerStructure
General properties Data can be exchanged in a synchronous or asynchronous manner, depending on specific processes and circumstances. The most common methods for asynchronous exchange are via File Transfer Protocol and message exchange platforms (MEP), often used in…
Unique identifiers and referrals
AFD 2.0 building blocks » Unique identifiers and referrals
Defining entities uniquely within the context of a message It must be possible for every instance of an entity to be uniquely identified within an AFD message, structure or function. This can be done in two ways: with functional and/or technical identifiers. With…
Change
Domain specific functions » Claim » Change
The operation change in case of a claim will replace an entity partially or completely, if the processes for handling and settling claims have not been completed, yet. A change to a claim might be necessary, for example, if the claim needs to be linked to another…
Change
Domain specific functions » Party » Change
The operation change in case of a party will replace a party partially or completely. How to use variants If you need to make changes to an existing party, choose the operation change. If it is only necessary to change some details, the variant ‘detail’…
Special limit
Domain specific functions » Contract » Special limit
The operation specialLimit requests and sends messages and registers contracts with conditions that deviate from the usual (standard) conditions. If contracts would have fit in the usual conditions the operation new would have been applicable. *The functions, variants…
New
Domain specific functions » Task » New
The operation new in case of a task will create a new task for a third party. Examples of tasks are inspection, valuation or repair of damage. The entityType assignment is always used in case of operation new. How to use variants This function is used to outsource a…
Retrieve
Domain specific functions » Task » Retrieve
The operation retrieve in case of a task will fetch task details which can contain information added by the third party, for instance status or planned time or date of execution. The entityType valuation is always used in case of operation retrieve. The data is…
New
Domain specific functions » Claim » New
The operation new in case of a claim is used to initiate the claim process with a first notification of loss. The insurance provider creates a claim file and assesses the claim. In the following steps the claim can be rejected, or claim handling will commence. These…
Change
Domain specific functions » Task » Change
The operation change in case of the entity task will replace an existing task partially or completely. Once the initial task has been sent to a contractor, it may be updated in order to supply additional information. For instance the (temporary) location where a…
Termination
Domain specific functions » Contract » Termination
The operation termination of a contract puts an end to a policy, loan, pension, master agreement or contract within a master agreement. *The functions, variants and structures concerning pension and loan are under construction and will follow in due time. How to use…
Renewal
Domain specific functions » Contract » Renewal
The operation renewal will return financial information or calculate the rate as a result of a renewal of a policy, loan, pension, master agreement or contract within a master agreement. *The functions, variants and structures concerning pension and loan are under…
Change
Domain specific functions » Contract » Change
The operation change of a contract will replace an entity partially or completely. An entity linked to a contract can be a policy, loan, pension, master agreement or contract within an existing master agreement. The payload consists of the structures needed in the…
New
Domain specific functions » Party » New
The operation new in case of a party will add a party. A party can be a natural person (e.g. partner, employee) or an organization (e.g. bank, insurance company). A party can exist without being connected (immediately) to a contract. How to use variants If you want…
documentStructure
AFD structures » documentStructure
General properties The documentStructure is basically made up of the document entity, a commonTechnical entity for technical metadata and a commonFunctional entity for functional metadata. The structure is used for exchanging a wide range of document related data: for…
Retrieve
Domain specific functions » Table » Retrieve
The operation retrieve will fetch data in a tabular structure for use in automated processes and user dialogs. Automated processes often use codelists to enforce the use of valid values for a specific attribute and keep the dataset compact. In a screen dialog this is…
New
Domain specific functions » Contract » New
The operation new in case of a contract will add a new policy, loan, pension, master agreement or contract within an existing master agreement). The payload consists of the structures needed in the particular situation, so it can be a policyStructure, a loanStructure,…
JSON Schema
AFD-definition standard » JSON Schema
Context JSON Schema is used for defining specifications of messages regarding structures, entities and attributes. The use of JSON Schema promotes the preparation of unambiguous specifications. In addition, JSON Schema can be used as a basis for automated checking of…
Retrieve
Domain specific functions » Claim » Retrieve
The operation retrieve in case of a claim will fetch the data or the status of a claim. The retrieval of a single claim can be used as input to a step in the claims handling process, or to provide current claim information to a portal or account page of the broker or…
Retrieve
Domain specific functions » Object » Retrieve
The operation retrieve in case of an object will fetch the data of an object. Different entity types are available within the objectStructure, for example motorVehicle or building. You can find a complete overview in AFD 2.0 online. How to use variants The…
AFD Short
Mapping » AFD Short
Based on the article ‘AFD Short – AFD 2.0-structuur met AFD 1.—attribuutnamen’ (in SIVI AFS Magazine June 2023). Transition to AFD 2.0 The transition from AFD 1.0 to AFD 2.0 was necessary for many reasons. In addition to the switch from…
objectStructure
AFD structures » objectStructure
General properties The main characteristic of the objectStructure is the presence of the object entity. In addition, all relevant entities are available to elaborate on any aspects of related information to the described object. Within the context of AFD, an object is…
taskStructure
AFD structures » taskStructure
General properties The main characteristics of the taskStructure are the presence of the task entity, which groups general information about a task for, for example, inspection, appraisal or repair of damage. Therefore, claim and claim-related entities (party, policy)…
ticketStructure
AFD structures » ticketStructure
General properties Within the insurance market, it is quite common to process customer reports using ‘tickets’. A ticket entity, including a ticketStructure and according attributes is available to support these processes. Mandatory components The table…
loanStructure
AFD structures » loanStructure
General properties The loanStructure is the main structure for exchanging and storing mortgage or other loan data, and is usually made up of the loan entity and two party entities indicating the parties mutually involved in the loan agreement. All relevant entities…
Retrieve
Domain specific functions » Party » Retrieve
The operation retrieve in case of a party will fetch the data of that party. How to use variants The operation retrieve is a webservice call without a body. For more information see the Retrieve operations section of the Design principles chapter. The output of…
Retrieve
Domain specific functions » Contract » Retrieve
The operation retrieve will fetch a policy, loan, pension, master agreement or contract within an existing master agreement for a single entry, a range or a list of entries. The output consists of the structures needed in the particular situation, so it can be a…
AFD-definition standard
AFD-definition standard
*Under construction. The AFD-definition Standard manual can be consulted in Dutch. The English version of the AFD-definition Standard 2.0 will be available soon. Introduction The digitization of insurance processes continues unabated. Applications and data exchange…
Introduction All Finance Data Catalog
AFD 2.0 building blocks » Introduction All Finance Data Catalog
Context and history The All Finance Data Catalog (AFD) forms the basis for the digital ecosystem (see also Introduction SIVI AFS). AFD determines how one denotes data (e.g. a date always in the same format) and how one groups this data in a structure (e.g. what data…
Retrieve
Technical functions » Message » Retrieve
*Under construction More detailed information on Message will follow in due time. The operation retrieve in case of a message will fetch the message details. How to use variants The retrieve operation is a webservice call without a body. For more information see…
partyStructure
AFD structures » 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…
New
Domain specific functions » Ticket » New
The operation new in case of a ticket will add a new ticket. A ticket can (for example) be a question, complaint or (claim) file, but the entityType is always default. How to use variants If you want to add a new ticket, choose the operation new. Only one variant is…
AFD structures
AFD structures
Outline of this chapter In the next sections the different structures are explained and defined. For each structure, it is indicated which entities can be used within the structure, and their occurrence requirements. Depending on the actual use of the structure,…
policyStructure
AFD structures » policyStructure
General properties The main characteristics of the policyStructure are the presence of the policy entity, a party entity with entityType policyHolder, an object entity to record the insured object, and a coverage entity to describe the protection provided by the…
Error messages SOAP and REST
Transaction standards » Error messages SOAP and REST
The information in this chapter is described with the REST architecture principles in mind. One of the key elements of that architecture is the fact that data exchange is based directly on the HTTP protocol, and does not use an intermediate layer for functions or…
claimStructure
AFD structures » claimStructure
General properties The claimStructure is made up of entities used to notify and register a loss, process a claim and create settlements. Given the fact that a claim is made against the cover of a policy, the policy and coverage entities are available in the…
Design principles
Domain specific functions » Introduction to all functions » Design principles
Introduction The All Finance API-framework describes API functionality as much as possible in general terms. Where technical context is relevant or needed the REST design principles are used. REST is a set of architectural constraints, not a protocol or a standard. In…
afsStructure
AFD structures » afsStructure
General properties The afsStructure is different from the other structures in that the afsStructure actually does not define any structure at all. The afsStructure only adheres to the set-up of entities and attributes, and can be seen as a ‘master schema’…
Operation and variant description: reading guide
Domain specific functions » Introduction to all functions » Operation and variant description: reading guide
This chapter is a reading guide to the detailed descriptions of all variants applicable for a cluster/operation combination. A general overview of the API-framework is available in Overview of the API-framework. You can find a detailed overview of all functions in…
JSON
Transaction standards » JSON
Introduction JSON is the abbreviation for JavaScript Object Notation. JSON is a syntax used in computer programming for using data in a structured way. JSON is a platform independent, open-standard syntax. Specific open standards such as JSON Schema and AJAX have been…
Insuring multiple objects
AFD structures » Insuring multiple objects
SIVI designed agreements and principles for the insurance of multiple objects as part of one policy. Within this scope, we specify three different policy constructions: Single policy: a separate or single policy per object, each with its own coverage, clauses and/or…
Change
Domain specific functions » Ticket » Change
The operation change in case of the entity ticket will replace an existing ticket partially or completely. Once the initial ticket has been filed, it may be updated in order to supply additional information. For instance with more information about a maintained claim…
masterAgreementStructure
AFD structures » masterAgreementStructure
General properties The masterAgreementStructure can be used to define a collection of contracts which are linked to each other by a master agreement, for example a package policy, or a framework pension contract. A masterAgreementStructure always consists of a single…
Overview of all functions
Domain specific functions » Overview of all functions
Introduction The SIVI API-framework function overview contains two documents. One document is based on the Category Functional and contains all the functional functions of this framework. The other document is based on the Category Technical and contains all the…
Retrieve
Domain specific functions » Ticket » Retrieve
The operation retrieve in case of a ticket will fetch ticket details which can contain information added by a third party, for example about a complaint or claim file. The data is selected by providing the {ticketId} as a path parameter of the…
Mapping-API
Mapping » Mapping-API
Based on the article ‘Mapping van AFD 1.0 naar AFD 2.0 geautomatiseerd’ (in SIVI AFS Magazine May 2022). Mapping-API for all mappings related to SIVI AFS SIVI offers an API to provide mappings from one data catalog to another. More specific, the API…
Introduction to technical functions
Technical functions » Introduction to technical functions
API-framework A short introduction into the API-framework is available in chapter Introduction to all functions. Structure of the API-framework The API-framework technical function hierarchy is designed to support a number of clusters. The clusters are grouped into…
Technical entities
AFD 2.0 building blocks » Entities » Technical entities
The AFD has three technical meta-entities in which information about the message can be stored. The commonFunctional entity covers all information about the content of the message. This is typically domain-specific information, while the commonTechnical entity…
Table
Domain specific functions » Table
In order to maintain consistency and traceability in the distribution chain, it is important that parties can exchange data in a tabular structure. The cluster table enables retrieval of information to incorporate in an agent application. It is a way to ensure that…
JMESPath
AFD-definition standard » JMESPath
JMESPath is used for defining specifications of validation rules between attributes that cannot be specified in JSON Schema. The use of JMESPath definitions promotes the creation of unambiguous specifications. JMESPath can be used to check the dependency between two or…
Swagger examples of domain specific functions
Domain specific functions » Swagger examples of domain specific functions
The SIVI AFS API framework and the overview of functions are the starting point for opening up APIs to the market. In this section we describe how this framework works, using some examples in SwaggerHub. By clicking the green button below, the user gets access to these…
error
AFD 2.0 building blocks » Entities » Technical entities » error
Entity: error The error entity is intended for communicating error messages, primarily used within the API-framework. Example usage Below is an example error entity, filled with some attributes. This example shows a check of the POR code at the moment of receival…
SOAP vs REST
Transaction standards » SOAP vs REST
*Under construction A more up-to-date description of the Transaction standards will follow in due time. Introduction The choice of a specific technical solution or application remains the responsibility of the individual party who develops an API, which is why the…
commonFunctional
AFD 2.0 building blocks » Entities » Technical entities » commonFunctional
Entity: commonFunctional The commonFunctional entity covers all information about the content of the message. This is typically domain-specific information, while the commonTechnical entity primarily provides technical message-related meta-data. Example usage Below…
AFD 2.0 building blocks
AFD 2.0 building blocks
Outline of this chapter This chapter describes the building blocks of AFD 2.0. The All Finance Data catalog consists of entities, attributes, data types, codelists and code values: An entity describes an object or thing from reality, for example a policy, party or…
commonTechnical
AFD 2.0 building blocks » Entities » Technical entities » commonTechnical
Entity: commonTechnical The commonTechnical entity covers all information about sending or storing the message. This is typically technical information, while the commonFunctional entity primarily provides domain-specific message-related meta-data. Example…
Object
Domain specific functions » Object
Clusters are grouped functions with the same characteristics and use. The cluster object contains all data with respect to an insured or financed object representing an interest for the owner. An overview of the clusters can be found in the Overview of the…
Party
Domain specific functions » Party
Clusters are grouped functions with the same characteristics and use. The cluster party contains all data with respect to a natural person or an organization. An overview of the clusters can be found in the Overview of the API-framework. The clusters are concentrated…
afsTableStructure
AFD structures » afsTableStructure
General properties Within AFD 2.0 and the API-framework, SIVI provides a function for exchanging data in a tabular structure.This enables parties to distribute content (such as tables of data or a codelist) which can be used in for example a drop-down list presented…
Task
Domain specific functions » Task
Clusters are grouped functions with the same characteristics and use. The cluster task contains general information about an assignment or task, for example, inspection, valuation or repair of damage. An overview of the clusters can be found in the Overview of the…
Validation
Domain specific functions » Object » Validation
The operation validation checks whether the object data are valid. An example of a validation is the check of the combination licence plate and chassis number for a motor vehicle. How to use variants The operation validation is a webservice call without a body. A…
Entities
AFD 2.0 building blocks » Entities
An entity describes an object or thing from reality, for example a policy, party or claim. AFD 2.0 consists of about thirty entities, which can be roughly divided into three categories: core entities (claim, coverage, loan, object, party, pension, policy), supporting…
Contract
Domain specific functions » Contract
Clusters are grouped functions with the same characteristics and use. The cluster contract contains everything for the contract administration or policy administration. An overview of the clusters can be found in the Overview of the API-framework. The clusters are…
claim
AFD 2.0 building blocks » Entities » Core entities » claim
Entity: claim The claim entity is used for the grouping of claim-related data. A claim is a request made by the insured for insurer remittance of payment due to loss incurred, and covered under the policy agreement. Example usage Below is an example claim entity,…
superStructure
AFD structures » superStructure
*The description of the superStructure is under construction: more examples and elaborations will follow in due time. Structures: general rules The general rule for structures is that structures should not be nested under other structures: for example, if you want to…
Introduction to all functions
Domain specific functions » Introduction to all functions
API-framework In addition to the All Finance Data Catalog (Introduction All Finance Data Catalog), the All Finance API-framework (AFA) forms the basis for the digital ecosystem (see also Introduction AFS). Within the digital ecosystem, the use of web services plays an…
Data types and arrays
AFD 2.0 building blocks » Data types and arrays
Data types In AFD 2.0, data types and format restrictions are separated. As a result, AFD 2.0 only has seven native data types: integer, decimal, string, date, time, timestamp and boolean. The inclusion of boolean instead of ADNLOG implements a much-anticipated wish…
Technical functions
Technical functions
Outline of this chapter In general, a function is an operational process performed by an API. This chapter focuses on the technical functions, while the chapter Domain specific functions describes the functional functions. On the highest level functions (in SIVI AFS)…
Hierarchical codelists
AFD 2.0 building blocks » Codelists » Hierarchical codelists
Context and motivation Values in AFD codelists do not always supply the level of detail individual parties or processes require. While some parties or processes can handle a global level, others require a very detailed level. An example of this is the codelist AFDSCL…
Security
Security
*Under construction A more up-to-date description of Security will follow in due time. Integral security agreements In daily practice it is very difficult to make integral security agreements throughout the distribution chain for all systems of all chain parties.…
Overview of the API-framework
Domain specific functions » Introduction to all functions » Overview of the API-framework
The API-framework is designed in four levels to find the right API in a few steps. The four levels of the API-framework are: Category Cluster Operation Variant In the remainder of this section all elements will be explained. Figure 5.1.1-1 API-framework…
Transaction standards
Transaction standards
Outline of this chapter The aim of the All Finance Standards is to be as future-proof as possible. On the other hand, linking protocols and – to a lesser extent – syntaxes are more subject to change. By dividing the standards into multiple layers, SIVI AFS can…
signal
AFD 2.0 building blocks » Entities » Supporting entities » signal
Entity: signal A signal is a message from a party (usually an intermediary or insurer) to a natural person (usually the consumer) following an event (eg. the customer has turned 18) with the request to take action (eg. updating of payment details). There are two kinds…
Abbreviations
Abbreviations
Abbreviations used in this manual are explained below. If you want more information about a topic, please contact SIVI for support. Abbreviation NL Description EN Description ADN Assurantie Data Netwerk Insurance Data…
Differences between AFD 1.0 and AFD 2.0
Manual SIVI All Finance Standard » Differences between AFD 1.0 and AFD 2.0
All Finance Data Catalog English as official language The demand for English documented SIVI standards is increasing. The first reason is that software development activities at for instance insurers, service providers and suppliers are increasingly (at least partly)…
Readers guide
Manual SIVI All Finance Standard » Readers guide
This manual describes and explains the SIVI All Finance Standard (SIVI AFS). If you have a managerial role, reading this chapter and subsequently paragraphs 2.1, 5.1 and chapter 14 will give you an overall impression of SIVI AFS. For those with a more substantive…
Claim
Domain specific functions » Claim
Clusters are grouped functions with the same characteristics and use. The cluster claim contains all data needed for claims handling. An overview of the clusters can be found in the Overview of the API-framework. The clusters are concentrated around AFD structures.…
Standard codelists
AFD 2.0 building blocks » Codelists » Standard codelists
Instead of a data type, the format of an AFD attribute can also be based on a codelist. With a codelist, the number of permitted values of an attribute can be limited further than in the case, a generic data type is used. For example, the attribute tripPurpose is of…
Standard attributes
AFD 2.0 building blocks » Attributes » Standard attributes
If attributes are sufficiently generic across the entire financial industry, they are suitable for standardization, and thus for inclusion in AFD. These attributes are standard attributes. Entities can be filled from a list of associated attributes. For example, the…
afsTable
AFD 2.0 building blocks » Entities » Supporting entities » afsTable
Entity: afsTable The afsTable entity is used for grouping data as a table, which can either be a (customized) codelist or a freely definable table using the tableColumn and tableRow entityTypes. See the example below for such a self-defined table: the table is given a…
Custom attributes
AFD 2.0 building blocks » Attributes » Custom attributes
Background Standard attributes do not always cover all situations, required by parties or processes. For example the development of a web service for the acceptance and premium calculation of a car insurance policy. In the data catalog of SIVI AFS you can find the…
Additional support
Additional support
Manual This manual is the first place of information for users of the AFD, API-framework and AFD-definitions. If information is missing or something is unclear, please contact support@sivi.org or call within office hours (030) 698 80 90. Requests for changes and…
XML
Transaction standards » XML
Introduction XML is the abbreviation for Extensible Markup Language. XML is a syntax used in computer programming to enable use of data in a structured way. XML is a platform independent syntax, maintained by W3C. Specific industry standards such as SOAP, XML Schema,…
Manual SIVI All Finance Standard
Manual SIVI All Finance Standard
This manual describes and explains the SIVI All Finance Standard (SIVI AFS). If you have any questions about this manual or suggestions for improvement, please do not hesitate to contact support@sivi.org or call within office hours (030) 698 80 90. Version…
Proprietary APIs
Proprietary APIs
The objective of the SIVI AFS API-framework is to provide a blueprint for generic functions that are used in the value chain of financial products. This enables parties to model their APIs in a standard format which is recognizable throughout the industry and…