Harmoney API Dossier Provider

Business goal

This provider can be used to enrich dossier data with data from an external API.

The external API should support fetching dossier data based on a certain identifier and the response must follow the Harmoney API Model (which is the same as the API Gateway model).

ℹ️ Note that the provider only supports API's that return a single dossier based on the given identifier.

⚙️ Configuration

• implementation class: HarmoneyApiDossierProvider
• resourceUri: Defines the URI of the API
• The URI must contain a {uniqueIdentifier} placeholder, which will be replaced with the identifier the user is searching on.
• The URI can contain a {fspExternalReference} placeholder, which will be replaced with the external reference of the FSP where the provider is being used.

Settings

Settings Configuration

Examples

Example(s)

Use Basic Authentication for the call to the API (and specify how the provider is shown in the UI)

{
    "LABEL_KEY": "PROVIDER.DOSSIER_PROVIDER.label",
    "DESCRIPTION_KEY": "PROVIDER.DOSSIER_PROVIDER.description",
    "authentication": {
        "BEARER_TOKEN": {
            "bearerToken": "<bearerToken>"
        }
    }
}

Example Response from an external API

{
  "dossier": {
    "identifier": {
      "externalIdentifier": "<dossier_id>"
    },
    "type": "KNOW_YOUR_CUSTOMER",
    "service": "KNOW_YOUR_CUSTOMER",
    "number": "ABC 123",
    "name": "Dossier Name",
    "client": {
      "externalIdentifier": "<client_id>"
    }
  },
  "associatedParties": [
    {
      "identifier": {
        "externalIdentifier": "<client_id>"
      },
      "individual": {
        "firstName": "Bart",
        "lastName": "Simpson",
        "email": "[email protected]",
        "nationality": "US",
        "gender": "MALE",
        "dateOfBirth": "1979-02-23",
        "address": {
          "fullStreet": "742 Evergreen Terrace",
          "postalCode": "1904",
          "city": "Springfield",
          "country": "US"
        }
      }
    }
  ]
}