FINS Insurance Library

This library defines a set of resources that are commonly used in API specifications designed for the MuleSoft Accelerator for Financial Services, which accelerates the implementation of essential integration use cases.

Data types

This library defines a number of data types related to insurance information, which form a canonical model used in most Process and System API specifications.

Usage

To use one or more of these resources in your API definition, first add this library as an Exchange dependency to your Design Center project. You can then import it into your main RAML file as follows:

uses:
  InsuranceTypes: exchange_modules/<groupid>/fins-insurance-library/1.4.1/fins-insurance-library.raml

You can then reference the exposed data types in your endpoints. For example:

/policies:
  get:
    description: Find one or more insurance policies matching a given set of criteria
    responses:
      200:
        body:
          application/json:
            type: InsuranceTypes.InsurancePolicy[]

Notes

If you update the version of the Exchange dependency you will need to manually update all file path references.