Search
Related topics are listed below.
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’…
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…
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…
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…
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…
Domain specific functions
Domain specific functions
Outline of this chapter The domain specific functions included in the SIVI API-framework cover a wide range of aspects of the operational processes related to the distribution of financial products. The functions included in this chapter are based on either preceding…
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…
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,…
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…
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…
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…
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…
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…
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…
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)…
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…
Session
Technical functions » Session
*Under construction More detailed information on Session will follow in due time. The exchange of data is always triggered by a process. This can be an automated process, or an interaction by a person handling data in an electronic environment. For example a workflow…
Introduction SIVI AFS
Manual SIVI All Finance Standard » Introduction SIVI AFS
SIVI digital ecosystem Within the financial services distribution, data and IT are increasingly preconditions for both the shaping of business activities (like acceptance of an insurance policy) and the development of customer services (for instance an insurance…
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…
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…
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…
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…
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…
process
AFD 2.0 building blocks » Entities » Supporting entities » process
Entity: process The process entity is used for grouping process-related data. Within the context of AFD 2.0, processes describe information about a status, associated with (for example) an application or a change. Example usage Below is an example process entity of…
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…
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…
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.…
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…
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…
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…
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…
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…
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…
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…
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…
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)…
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,…
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…
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…
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…
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…
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…