Credit Bureau Configuration maintains the configurations of respective Integrated Credit Bureau :
+ + +Field Descriptions |
+
| CreditBureauId | +
| Id assigned to the Integrated Credit Bureau. | +
| organisationCreditBureauId | +
| Id assigned to the created Alias of the Integrated Credit Bureau. | +
| configurationKey | +
| configurationKey is the name of the parameter which is assigned for fetching the configurations. | +
| value | +
| value is the name of the parameter which is assigned to the configurationKey. | +
| creditBureauConfigurationId | +
| creditBureauConfigurationId is the Id of the configurationKey-value pair of Credit Bureau Configuration. | +
| description | +
| Description of the specific credit bureau configuration. | +
Get Information of the Integrated Credit Bureau.
+ +
+GET https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration
+
+
+GET CreditBureauConfiguration
+
+
+{
+ "creditBureauId": 1,
+ "creditBureauName": "THITSAWORKS",
+ "country": "Myanmar",
+ "productName": "1",
+ "creditBureauSummary": "1 - THITSAWORKS - Myanmar",
+ "implementationKey": 1
+}]
+
+ Create a Credit Bureau Configuration.
+Mandatory Fields |
+
| creditBureauId, configkey | +
Optional Fields |
+
| value, description | +
+POST https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/configuration/{creditBureauId}
+
+
+POST CreditBureauConfiguration/configuration/1
+Content-Type: application/json
+Request Body:
+{
+"configkey":"configurationkey",
+"value":"value of the key",
+"description":"description of the configuration"
+}
+
+
+{
+ "resourceId": 10
+}
+
+ Get Credit Bureau Configuration.
+Mandatory Fields |
+
| organisationCreditBureauId | +
+GET https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/config/{organisationCreditBureauId}
+
+
+GET CreditBureauConfiguration/config/1
+
+
+[{
+ "creditBureauConfigurationId": 1,
+ "configurationKey": "Password",
+ "value": "password",
+ "organizationCreditBureauId": 1,
+ "description": "password of the CreditBureauId:1"
+}, {
+ "creditBureauConfigurationId": 2,
+ "configurationKey": "SubscriptionId",
+ "value": "subscriptionId",
+ "organizationCreditBureauId": 1,
+ "description": "subscriptionId of the CreditBureauId:1"
+}
+
+ Update a Credit Bureau Configuration.
+Mandatory Fields |
+
| configurationId, value | +
Optional Fields |
+
| description | +
+PUT https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/configuration/{configurationId}
+
+
+PUT CreditBureauConfiguration/configuration/10
+Content-Type: application/json
+Request Body:
+{
+"value":"changing value of the key",
+"description":"changing the description"
+}
+
+
+{
+ "resourceId": 10,
+ "changes": {
+ "value": "changing value of the key",
+ "description": "changing the description"
+ }
+}
+
+ Creating the Alias of the Integrated Credit Bureau with the different names with the Active status.
+Mandatory Fields |
+
| alias,creditBureauId | +
Optional Fields |
+
| isActive | +
+POST https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/organisationCreditBureau/{organisationCreditBureauId}
+
+
+POST CreditBureauConfiguration/organisationCreditBureau/1
+Content-Type: application/json:
+{
+"alias":"CreditBureau of Thitsaworks",
+"isActive":false,
+"creditBureauId":"1"
+}
+
+
+{
+ "resourceId": 1
+}
+
+ Organisation Credit Bureau is the Alias of the Integrated Credit Bureau.
+
+GET https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/organisationCreditBureau
+
+
+GET CreditBureauConfiguration/organisationCreditBureau
+
+
+[{
+ "organisationCreditBureauId": 1,
+ "alias": "CreditBureau of Thitsaworks",
+ "creditBureauId": 1,
+ "creditBureauName": "THITSAWORKS",
+ "creditBureauProduct": "1",
+ "creditBureauCountry": "Myanmar",
+ "creditBureauSummary": "1 - THITSAWORKS - Myanmar",
+ "isActive": false
+}]
+
+ Update Organisational Credit Bureau.
+Mandatory Fields |
+
| creditBureauId | +
Optional Fields |
+
| isActive | +
+PUT CreditBureauConfiguration/configuration/organisationCreditBureau
+
+
+PUT CreditBureauConfiguration/organisationCreditBureau
+Content-Type: application/json:
+{
+"creditBureauId":"1",
+"isActive":true
+}
+
+
+{
+ "resourceId": 1
+}
+
+ Mapping of the Credit Bureau with Loan Products.
+Mandatory Fields |
+
| loanProductId, isCreditcheckMandatory, skipCreditcheckInFailure, isActive, stalePeriod, locale | +
+POST https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/mappings/{CreditBureauId}
+
+
+POST CreditBureauConfiguration/mappings/1
+Content-Type: application/json:
+{
+"loanProductId":"1",
+"isCreditcheckMandatory":true,
+"skipCreditcheckInFailure":true,
+"isActive":true,
+"stalePeriod":"5",
+"locale":"en"
+}
+
+
+{
+ "resourceId": 1
+}
+
+ Get All Credit Bureau - Loan Product Mappings.
+
+GET https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/mappings
+
+
+GET CreditBureauConfiguration/mappings
+
+
+[{
+ "creditbureauLoanProductMappingId": 1,
+ "organisationCreditBureauId": 1,
+ "alias": "CreditBureau of Thitsaworks",
+ "creditbureauSummary": "1 - THITSAWORKS - Myanmar",
+ "loanProductName": "LOAN_PRODUCT_MYANMAR",
+ "loanProductId": 1,
+ "isCreditCheckMandatory": true,
+ "skipCrediCheckInFailure": true,
+ "stalePeriod": 5,
+ "isActive": true
+}]
+ Update Credit Bureau-Loan Product Mapping.
+Mandatory Fields |
+
| creditbureauLoanProductMappingId, isActive | +
+PUT https://DomainName/fineract-provider/api/v1/CreditBureauConfiguration/mappings
+
+
+PUT CreditBureauConfiguration/mappings
+Content-Type: application/json:
+{
+"creditbureauLoanProductMappingId":1,
+"isActive":false
+}
+
+
+{
+ "resourceId": 1
+}
+
+ ThitsaWorks Credit Bureau Integration fetches the Credit Report from the ThitsaWorks :
+ + +Field Descriptions |
+
| creditBureauId | +
| Id assigned to the Integrated Credit Bureau. | +
| params | +
| params is the Map parameter which has specific keys,values which are required to fetch the credit Reports. + NRC: to fetch ThitsaWorks Credit Reports. |
+
| creditReportNumber | +
| creditReportNumber is the general term to access the Credit Reports. | +
Fetches the Credit Report.
+Mandatory Fields |
+
| NRC, creditBureauID | +
+POST https://DomainName/fineract-provider/api/v1/creditBureauIntegration/creditReport
+
+
+POST creditBureauIntegration/creditReport
+Content-Type: application/json
+{
+"NRC":"12/KaMaRa(N)253429",
+"creditBureauID":"1"
+}
+
+
+{
+ "creditBureauReportData":{
+ "name":"Lwin Moe",
+ "gender":"",
+ "address":"",
+ "creditScore":{
+ "Score":"N/A",
+ "Class":"N/A",
+ "Note":""
+ },
+ "borrowerInfo":{
+ "MainIdentifier":"1113294790",
+ "Name":"Lwin Moe",
+ "NRC":"12/KaMaRa(N)253429",
+ "Gender":"",
+ "DOB":"1990-12-25,1990-01-20",
+ "FatherName":"",
+ "Address":"",
+ "LastUpdateDtm":"Jul 8 2020 3:57PM",
+ "PrintedDtm":"Dec 16 2020 4:46AM"
+ }
+ }
+}
+
+ Gets Saved Credit Report Information to download the credit Report which are stored in database.
+Mandatory Fields |
+
| creditBureauID | +
+GET https://DomainName/fineract-provider/api/v1/creditBureauIntegration/creditReport/{creditBureauId}
+
+
+GET creditBureauIntegration/creditReport/1
+
+
+[{
+ "id": 3,
+ "creditBureauId": 1,
+ "nrc": "12/MaGaDa(N)253426"
+}, {
+ "id": 4,
+ "creditBureauId": 1,
+ "nrc": "12/KaMaRa(N)253426"
+}]
+
+