FTOS_BP_GetInsuranceListDetail

Returns the details of a specific insurance list based on its name or id.

Syntax

The FTOS_BP_GetInsuranceListDetail custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.

Copy 
POST <host_address>/ftosapi/automation-processors/actions/FTOS_BP_GetInsuranceListDetail
Content-Type: application/json
            
{
  "insuranceListName": "<name_of_insurance_list>",
  "insuranceListId": "<id_of_insurance_list>"
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the FintechOS Platform server.
insuranceListName Mandatory when insuranceListId is not sent, string. The name of the insurance list.
insuranceListId Mandatory when insuranceListName is not sent, string. The id of the insurance list.

Response

The response is an object with details about all the insurances in the insurance list from the FTOS_BP_Insurance and FTOS_BP_InsuranceValue entities. If use Banking Formula is selected, then insurance value or insurance percent is equal to the formula result.

Example

To view the details of a specific insurance list, send the following request, changing the name of the insurance list with the one you need.

Request

Copy 
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/FTOS_BP_GetInsuranceListDetail
Content-Type: application/json
            
{
  "insuranceListName": "Advanced Loan Insurance List"
}

Response

Copy 
{
    "InsuranceListName": "Advanced Loan Insurance List",
    "Insurances": [
        {
            "InsuranceCode": "LI EUR",
            "InsuranceName": "LifeInsurance EUR",
            "PeriodicityType": "Monthly",
            "Currency": "EUR",
            "Insurer": null,
            "OperationItem": null,
            "IsMandatoryForApplicant": "false",
            "IsMandatoryForDebtor": "false",
            "IncludedIntoRepaymentScheduleInstallment": true,
            "Class": "Life Insurance",
            "UseBankingFormula": false,
            "ValueIsPercentage": false,
            "Description": null,
            "BankingFormulaType": null
        }
    ]
}

To view the details of a specific insurance list, send the following request, changing the id of the insurance list with the one you need.

Request

Copy 
POST https://your_FintechOS_server/ftosapi/automation-processors/actions/FTOS_BP_GetInsuranceListDetail
Content-Type: application/json
            
{
  "insuranceListId": "69F68823-40A3-401A-A6DC-BACE3EA5C970"
}

Response

Copy 
{
    "InsuranceListName": "Advanced Loan Insurance List",
    "Insurances": [
        {
            "InsuranceCode": "LI EUR",
            "InsuranceName": "LifeInsurance EUR",
            "PeriodicityType": "Monthly",
            "Currency": "EUR",
            "Insurer": null,
            "OperationItem": null,
            "IsMandatoryForApplicant": "false",
            "IsMandatoryForDebtor": "false",
            "IncludedIntoRepaymentScheduleInstallment": true,
            "Class": "Life Insurance",
            "UseBankingFormula": false,
            "ValueIsPercentage": false,
            "Description": null,
            "BankingFormulaType": null
        }
    ]
}