tree: f1de09a2b73ee2c1afd0b3f7398bf313cefcd3be [path history] [tgz]
  1. docs/
  2. src/
  3. build.gradle


Fineract Credit Scorecard

  • API version: 0.1.0-SNAPSHOT

An API module for credit risk assessment

Automatically generated by the OpenAPI Generator


Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle


To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:


Gradle users

Add this dependency to your project's build file:

compile "org.apache.fineract:credit-scorecard-java-client:0.1.0-SNAPSHOT"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/credit-scorecard-java-client-0.1.0-SNAPSHOT.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes: import; import; import; import*; import; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath(""); AlgorithmsApi apiInstance = new AlgorithmsApi(defaultClient); Algorithm algorithm = new Algorithm(); // Algorithm | try { Algorithm result = apiInstance.algorithmsCreate(algorithm); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AlgorithmsApi#algorithmsCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } }

Documentation for API Endpoints

All URIs are relative to

ClassMethodHTTP requestDescription
AlgorithmsApialgorithmsCreatePOST /api/v1/algorithms
AlgorithmsApialgorithmsDestroyDELETE /api/v1/algorithms/{id}
AlgorithmsApialgorithmsListGET /api/v1/algorithms
AlgorithmsApialgorithmsPartialUpdatePATCH /api/v1/algorithms/{id}
AlgorithmsApialgorithmsPredictPOST /api/v1/algorithms/predict
AlgorithmsApialgorithmsRetrieveGET /api/v1/algorithms/{id}
AlgorithmsApialgorithmsUpdatePUT /api/v1/algorithms/{id}
DatasetsApidatasetsListGET /api/v1/datasets
DatasetsApidatasetsRetrieveGET /api/v1/datasets/{id}
RequestsApirequestsCreatePOST /api/v1/requests
RequestsApirequestsDestroyDELETE /api/v1/requests/{id}
RequestsApirequestsListGET /api/v1/requests
RequestsApirequestsPartialUpdatePATCH /api/v1/requests/{id}
RequestsApirequestsRetrieveGET /api/v1/requests/{id}
RequestsApirequestsUpdatePUT /api/v1/requests/{id}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:


It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.