Baloise

Mortgage Insurance API

Version:  1.0
State:  Published
Environment: Sandbox
Base URI: https://apis-sbx.luxhub.com/mortgage-insurance-api
Types: OPEN

Mortgage Insurance API

 

This set of APIs enables the customer to obtain an estimated price quotation and to submit a new request if the estimate is validated.

 

  1. Price estimation

 The API to call to get a price estimation for a SRD (Solde Restant Dû) is /api/v1/Pricing/GetPricingSRD

 Input parameter

 This method takes the following parameters as input :

 {

  “pricingTypeSRD”: “”,

  “assureds”: [

    {

      “birthdate”: “2021-05-17T06:36:50.922Z”,

      “isSmoker”: true

    }

  ],

  “amount”: 0,

  “interestRate”: 0,

  “monthNumber”: 0,

  “startDate”: “2021-05-17T06:36:50.922Z”

}

 

  • PricingTypeSRD : Represents the type of SRD you want to receive an estimation for.
    The different values for this parameter are:
    • Monthly : Insurance premium paid monthly (start date must be the 1th or the 15th of a month)
    • Yearly : Insurance premium paid yearly (Start date must be the 1st or the 15th of a month)
    • Unique : Unique insurance premium
  • Amount : the amount of the loan to be insured
  • interestRate : the interest rate of the loan
  • monthNumber : the duration of the loan in month
  • startDate : the start date of the loan
  • assureds : information about the insured people

 

Output response

The API returns the following response:

{

  "value": 0,

  "error": "string"

}

 

  • value : the estimated price of the SRD
  • error : description of the error

 

Example

 

curl -X POST "https://apis-<env>.luxhub.com/mortgage-insurance-api/api/v1/Pricing/GetPricingSRD"-H "Authorization: Bearer XXXX" -H "accept: application/json" -H "Username: DemoBank" -H "Content-Type: application/json" -d "{\"pricingTypeSRD\":\"Monthly\",\"assureds\":[{\"birthDate\":\"2000-05-17T07:31:36.650Z\",\"isSmoker\":true}],\"amount\":300000,\"interestRate\":0.25,\"monthNumber\":180,\"startDate\":\"2021-05-17T07:31:36.650Z\"}"

 

Response:

{

  "value": 33.28,

  "error": null

}

 

  1. Request submission

 The API to call to submit a new request is /api/v1/Pricing/RequestSRDSubscription

 

Input parameter

This method takes the following parameters as input :

 {

  "pricingTypeSRD": "",

  "assureds": [

    {

      "order": 0,

      "birthDate": "2021-05-17T07:31:36.650Z",

      "isSmoker": true,

      "firstName": "string",

      "lastName": "string",

      "maidenName": "string",

      "gender": "string",

      "language": "string",

      "address": {

        "street": "string",

        "number": "string",

        "postalCode": "string",

        "town": "string",

        "country": "string"

      },

      "mail": "string",

      "phoneNumber": "string"

    }

  ],

  "amount": 0,

  "interestRate": 0,

  "monthNumber": 0,

  "startDate": "2021-05-17T07:31:36.650Z",

  "requestedBy": {

    "firstName": "string",

    "lastName": "string",

    "address": {

      "street": "string",

      "number": "string",

      "postalCode": "string",

      "town": "string",

      "country": "string"

    },

    "mail": "string",

    "phoneNumber": "string",

    "language": "string"

  }

}

 

  • PricingTypeSRD : Represents the type of SRD you want to receive an estimation for.
    The different values for this parameter are:
    • Monthly : amount to reimburse monthly
    • Yearly : amount to reimburse yearly
    • Unique : amount to reimburse one time
  • Amount : the amount of the loan to be insured
  • interestRate : the interest rate of the loan
  • monthNumber : the duration of the loan in month
  • startDate : the start date of the loan
  • assureds : information about the insured people
  • requestedBy : information about the person who requested the SRD.

 

Output response

The method returns a string, indicating that the request is processing

 

Example

 

curl -X POST "https://apis-<env>.luxhub.com/mortgage-insurance-api/api/v1/Pricing/RequestSRDSubscription" -H "Authorization: Bearer XXXX" -H "accept: application/json" -H "Username: DemoBank" -H "Content-Type: application/json" -d "{\"pricingTypeSRD\":\"Monthly\",\"assureds\":[{\"order\":0,\"birthDate\":\2000-05-17T07:31:36.650Z\",\"isSmoker\":true,\"firstName\":\"Jean\",\"lastName\":\"Dupond\",\"maidenName\":\"\",\"gender\":\"M\",\"language\":\"fr\",\"address\":{\"street\":\"rue de la plaine\",\"number\":\"3\",\"postalCode\":\"2345\",\"town\":\"Luxembourg\",\"country\":\"Luxembourg\"},\"mail\":\"This email address is being protected from spambots. You need JavaScript enabled to view it.\",\"phoneNumber\":\"003521234567\"}],\"amount\":300000,\"interestRate\":0.25,\"monthNumber\":180,\"startDate\":\"2021-05-17T07:31:36.650Z\",\"requestedBy\":{\"firstName\":\"Jean\",\"lastName\":\"Dupont\",\"address\":{\"street\":\"rue de la vallée\",\"number\":\"4\",\"postalCode\":\"8767\",\"town\":\"Luxembourg\",\"country\":\"Luxembourg\"},\"mail\":\"This email address is being protected from spambots. You need JavaScript enabled to view it.\",\"phoneNumber\":\"00352987654\",\"language\":\"fr\"}}"

 

Response:

The request has been recorded successfully.

 

This website uses cookies. By continuing to use our website, you accept the use of these cookies.