API Catalogue
Below is a full list of all APIs available in the Fenergo SaaS platform along with a brief description and links to the published swagger for each. Refer to our guide on using Swagger and Postman for information on how to connect to and call the APIs.
Advanced Reporting API
The Advanced Reporting API allows users to extract data from their Fen-X tenant using SQL queries. This feature allows users to save and execute SQL queries that generate downloadable CSV files.
Association API
The Association API is used to connect Legal Entities together and build up ownership and control hierarchies in fenergo.
Audit API
The Audit API is used to read Audit events back from the Audit Trail. There is no "command" api publicly available, it is not permitted to push entries or updates to the Audit Log.
Authorization API
The Authorization API is used create and manage teams, user teams assignments, access layers as well as adding users to access layers. You can also then retrieve Access Layer, User and Team Data.
Bulk Load API
The Bulk Load APIs are behind the UI functionality for bulk requests and allow users to upload up to 250 LE records and have the Fenergo platform create cases.
Business Metrics API
The Business metrics API provides access to creating asynchronous Journey summary's.
Credit Assessment API
As part of credit origination process, Credit Assessment API provides both configurational and operational methods for clients to conduct their credit assessment. Use Credit Assessment Command API to create and update Credit Screening Assessment. Use the Query API to retrieve credit assessment data.
Credit Screening API
As part of credit origination process, Credit Screening API provides both configurational and operational methods for clients to conduct their credit screening request with different providers. Use Credit Screening Command API to create and update Credit Screening Providers/Configurations and request screening. Use the Query API to retrieve credit screening data.
Dashboards API
The Dashboards API contains all the functionality behind the fenergo application landing page. Majority of functionality as expected is to query the data behind the displayed dashboards but the command API allow the setting and bulk setting of favorite tasks.
Data Migration API
The Data Migration functionality of fenergo is exclusively offered through APIs. From here users can create a migration session, retrieve relevant staging files, upload the data to be migrated, start and monitor the progress of a migration and also retrieve reconciliation and error files. Data migration is covered in detail within the technical documentation.
Digital ID&V API
Digital ID&V (Identity and Verification) is functionality to verify an individual is who they claim to be and is a step clients can enable in their journeys.
Document Management API
As part of gathering data, fenergo also supports the gathering of documents against document requirements which are generated when creating cases or simply the association of documents to Legal Entities.
Entity Data API
Legal Entity Data is the cornerstone of the fenergo platform and the below APIs facilitate working with Legal Entity Data and Draft Data Records.
Event Ingress API
Fenergo supports clients sending incoming messages to FenX via the Event Ingress API. This is not a Command / Query pattern. Read more about the Event Ingress pattern here.
Event Notifications API
Fenergo supports two types of notifications, Polling and Webhooks. These APIs allow you to configure and manage the webhooks and also perform the polling. This is not a Command / Query pattern. Working with notifications is covered in detail in our documentation.
External Data API
As part of the Legal Entity enrich stage, clients can choose to search and retrieve data from an external authoritative data source - such as BvD or Kompany which are available as out of the box integrations. Alternately clients can choose to use the External Data Provider Adapter pattern and configure the platform to talk to their own custom Data Provider.
External Data Outreach API
The External Data Outreach API is used for external outreach to gather data to assist and progress Client journeys.
Financial Analysis API
As part of credit origination process, Financial Analysis API provides both configurational and operational methods for clients to conduct their financial analysis. Use the Financial Analysis Command API to create and update new and existing financial analysis data. Use the Query API to retrieve financial analysis data.
Journey API
Journeys are how we refer to workflows which have stages, processes and tasks. The API can be used to create, interact with and query journeys on the fenergo platform. There is also a Journey Logic Engine which allow users to determine which Journey is in scope for a given client.
Localisation API
The Localisation API provides both configurational and operational methods related to the client localisations. Use the Localisation Command API to create and update new and existing localisations and versions. Use the Query API to retrieve localisations and aggregates.
Lookup API
Lookup APIs provides both configurational and operational methods related to the client lookups. Use the Lookup Command API to create and update new and existing lookups and versions & the Query API to retrieve lookups and aggregates.
New Request API
The New Request API allows to configure the steps for the new request flow.
Outreach API
The Outreach API manage the email domains via Mailgun. Also provides to the users the ability to send emails using the default email templates.
Policy & Policy Logic Engine API
Policy and Logic engine APIs allow the creation and query of policy's on the fenergo platform. The engine allows a way to dynamically test for policy conditions in scope.
External Fields / Data Group - Policy Provider API
FenX provides the ability for clients to search for data & validate data from an external provider and use those results as "suggestions" in the UI that a user can select from. Support is also available for a collection of fields (in a Data Group).
Product API
Product Command API provides both configurational and operational methods related to the clients products. Use the Product Command API to create and update new and existing products. Use the Query API to retrieve products and aggregates.
Reporting API
The out of the box reports available on the application user interface can be interacted with via the API. There are reports which can return data in either CSV format or JSON. There are currently no operations defined for the command api.
Risk API
The Risk API allows clients to create and manage the components of a risk model which includes **Risk Model, Threshold Model and Configuration Models". The query API allows risk calculations to be performed. Interacting with Risk via the APIs is covered in detail within the documentation.
SCIM API
SCIM (System for Cross-Domain Identity Management) is an industry standard specification designed to bring consistency to the management of user identities in cloud-based applications and services.
Screening API
The Screening API allows system users to interact with the Legal Entity Screening functionality offered by the fenergo application. Also as part of the extensibility options, there is an endpoint for the Screening Receptor which can be used by clients who are implementing a custom screening provider.
Transaction Monitoring API
The Fenergo SaaS platform offers a number of APIs that interact with and provide functionality for our Transaction Monitoring Offering.