FINS Common 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 core data types, which can be used in any of the Banking, Insurance, or Wealth sub-verticals to build out their canonical data models.

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 and then import it into your main RAML file as follows:

uses:
  CommonTypes: exchange_modules/<groupid>/fins-common-library/1.5.4/fins-common-library.raml

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

/documents:
  get:
    description: Find one or more documents matching a given set of criteria.
    responses:
      200:
        body:
          application/json:
            type: CommonTypes.Document[]

Notes

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