Existing Mortgages

Return a specific existing mortgage

Changed on Aug 25, 2025

A specific existing mortgage including the corresponding properties and related mortgages.

get/mortgages/{mortgageId}

Request

Base URL
https://mortgage.common-api.ch
URL
https://mortgage.common-api.ch/mortgages/{mortgageId}
Auth
- API key in header X-API-Key
- or OAuth 2
  Authorization code: https://example.com/oauth/authorize
  Token URL: https://example.com/oauth/token scopes: read, write

Path parameters

mortgageIdstring uuid required

Uuid v4 of the mortgage.

Example:4bf92636-14a0-4511-98e2-acfde576e644

Uuid v4 of a specific existing mortgage.

Headers

X-CorAPI-Client-IDstring required

ID of the client forwarded to the provider.

X-Correlation-IDstring required

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agentstring required

Name and version of the of the Client software.

Response

Mortgage details with the corresponding properties and related mortgages.

Example response

{
  "Mortgage": {
    "amountAtExpiry": {
      "content": "235.45",
      "currency": "CHF"
    },
    "durationType": 5,
    "interestBasis": "We need an example",
    "interestRate": "1.4",
    "interestRateType": "libor",
    "mortgageId": "4bf92636-14a0-4511-98e2-acfde576e644",
    "product": {
      "interestRateType": "libor",
      "names": [
        {
          "description": "Fixed rate mortgage",
          "language": "fr"
        }
      ],
      "productId": "4bf92636-14a0-4511-98e2-acfde576e644",
      "productVariations": [
        {
          "duration": 5,
          "rate": 0.5,
          "saronperiod": "3m"
        }
      ]
    },
    "propertyObjects": [
      {
        "address": {
          "country": "CH",
          "postCode": "CH-2501",
          "streetName": "Rue de la gare",
          "townName": "Biel",
          "buildingNumber": "24A"
        },
        "propertyObjectId": "9343dd26-4b54-4808-8978-538f8e869d0e",
        "buildingRight": {
          "buildingRightExpiry": "2018-04-13",
          "buildingRightRent": {
            "content": "235.45",
            "currency": "CHF"
          },
          "buildingRightCompensation": {
            "content": "235.45",
            "currency": "CHF"
          }
        },
        "buildingStandardBathroom": "basic",
        "buildingStandardFloorCoverings": "basic",
        "buildingStandardKitchen": "basic",
        "ceilingHight": "middle",
        "classOfProperty": "main_residence",
        "collateralValue": {
          "content": "235.45",
          "currency": "CHF"
        },
        "estimation": {
          "estimationId": "asd23f",
          "estimationSourceType": "iazi",
          "marketValue": {
            "content": "235.45",
            "currency": "CHF"
          },
          "statisticalPriceRangeMax": {
            "content": "235.45",
            "currency": "CHF"
          },
          "statisticalPriceRangeMin": {
            "content": "235.45",
            "currency": "CHF"
          },
          "yearlyRentalIncome": {
            "content": "235.45",
            "currency": "CHF"
          },
          "estimationDate": "2018-04-13"
        },
        "floorPlan": "average",
        "heatEmission": [
          "floor"
        ],
        "heatProduction": [
          "gas"
        ],
        "investmentCost": {
          "content": "235.45",
          "currency": "CHF"
        },
        "limitForLandEncumbrances": {
          "content": "235.45",
          "currency": "CHF"
        },
        "matrimonialPropertyScheme": "separateEstate",
        "name": "My Nice Property",
        "objectPrice": {
          "content": "235.45",
          "currency": "CHF"
        },
        "propertyBuildingInformation": {
          "livingSpace": {
            "livingSpaceInSqm": 120,
            "measurementStandard": "nla"
          },
          "volumeIncludingGarageInhouse": 1500,
          "volumeIncludingAllGarages": 1620,
          "landArea": 2000,
          "environmentStandard": "basic",
          "otherFeatures": [
            "outdoor_pool"
          ],
          "houseType": "detached_house",
          "normType": "building_insurance"
        },
        "propertyConstructionInformation": {
          "constructionYear": 1990,
          "renovationYear": 1990,
          "propertyRenovations": [
            {
              "refurbishmentComponentType": "interior_fittings_floor_cover",
              "yearOfRenovation": 2015,
              "renovationCost": {
                "content": "235.45",
                "currency": "CHF"
              }
            }
          ],
          "minergieStandardType": "minergie-p",
          "BECCStandardType": "B",
          "luxusFlag": "0",
          "constructionQualityType": "good",
          "stateBuildingType": "good"
        },
        "propertyElements": {
          "numberOfRooms": 4.5,
          "numberOfRoomsInGrannyFlat": 2.5,
          "roomCountType": "kitchen_full_room",
          "numberOfFamilyBathrooms": 2,
          "numberOfBathWC": 2,
          "numberOfGuestWC": 2,
          "numberOfExternalParking": 2,
          "numberOfSeparateGarages": 2,
          "numberOfExternalSeparateGarages": 2,
          "numberOfAttachedGarages": 2,
          "numberOfUndergroundCarParks": 2
        },
        "propertyFlatInformation": {
          "numberOfFlats": 10,
          "numberOfFloors": 4,
          "stateApartmentType": "good",
          "floor": 2,
          "balconyOrTerraceArea": 20,
          "livingSpace": {
            "livingSpaceInSqm": 120,
            "measurementStandard": "nla"
          },
          "otherFeatures": [
            "coowned_outdoor_pool"
          ],
          "quote": 120,
          "apartmentType": "floor_flat",
          "buildingType": "multiple_family_house",
          "locationInTheBuildingRating": "good"
        },
        "propertyIdentifier": {
          "EGID": "191092250",
          "EGRID": "CH480928387782",
          "EWID": "42"
        },
        "propertyLinks": [
          {
            "url": "https://example.com/property.png",
            "description": "The image shows the aerial view of the property",
            "name": "Property image"
          }
        ],
        "propertyType": "single_family_house",
        "publicNotarization": "2018-04-13",
        "remarks": "We need an example for such a remark",
        "renovationAmount": {
          "content": "235.45",
          "currency": "CHF"
        },
        "transferOfOwnershipDate": "2018-04-13",
        "usageType": "self"
      }
    ],
    "validFrom": "2018-04-13",
    "validTo": "2018-04-13",
    "amountToday": {
      "content": "235.45",
      "currency": "CHF"
    },
    "offerDate": "2018-04-05"
  }
}

Changes

Aug 25, 20255d5a42b0d072 Revision changes
- warning
  added the new 2or3_family_house enum value to the /// response property for the response status
- warning
  added the new agricultural_farm enum value to the /// response property for the response status
- warning
  added the new building_plot_other enum value to the /// response property for the response status
- warning
  added the new commercial_condominium enum value to the /// response property for the response status
- warning
  added the new condominium enum value to the /// response property for the response status
- warning
  added the new industrial_building enum value to the /// response property for the response status
- warning
  added the new let enum value to the /// response property for the response status
- warning
  added the new mixed_property enum value to the /// response property for the response status
- warning
  added the new multi_family_house enum value to the /// response property for the response status
- warning
  added the new office_building enum value to the /// response property for the response status
- warning
  added the new residential_building_plot enum value to the /// response property for the response status
- warning
  added the new self enum value to the /// response property for the response status
- warning
  added the new single_family_house enum value to the /// response property for the response status
- warning
  added the new special_object enum value to the /// response property for the response status
- warning
  added the new vacation_condominium enum value to the /// response property for the response status
- warning
  added the new vacation_house enum value to the /// response property for the response status
- info
  removed the 2or3_family_house enum value from the /// response property for the response status
- info
  removed the agricultural_farm enum value from the /// response property for the response status
- info
  removed the building_plot_other enum value from the /// response property for the response status
- info
  removed the commercial_condominium enum value from the /// response property for the response status
- info
  removed the condominium enum value from the /// response property for the response status
- info
  removed the industrial_building enum value from the /// response property for the response status
- info
  removed the let enum value from the /// response property for the response status
- info
  removed the mixed_property enum value from the /// response property for the response status
- info
  removed the multi_family_house enum value from the /// response property for the response status
- info
  removed the office_building enum value from the /// response property for the response status
- info
  removed the residential_building_plot enum value from the /// response property for the response status
- info
  removed the self enum value from the /// response property for the response status
- info
  removed the single_family_house enum value from the /// response property for the response status
- info
  removed the special_object enum value from the /// response property for the response status
- info
  removed the vacation_condominium enum value from the /// response property for the response status
- info
  removed the vacation_house enum value from the /// response property for the response status
Jul 31, 2025ec48626881dd Revision changes
- warning
  added the new 2or3_family_house enum value to the /// response property for the response status
- warning
  added the new agricultural_farm enum value to the /// response property for the response status
- warning
  added the new building_plot_other enum value to the /// response property for the response status
- warning
  added the new commercial_condominium enum value to the /// response property for the response status
- warning
  added the new condominium enum value to the /// response property for the response status
- warning
  added the new industrial_building enum value to the /// response property for the response status
- warning
  added the new let enum value to the /// response property for the response status
- warning
  added the new mixed_property enum value to the /// response property for the response status
- warning
  added the new multi_family_house enum value to the /// response property for the response status
- warning
  added the new office_building enum value to the /// response property for the response status
- warning
  added the new residential_building_plot enum value to the /// response property for the response status
- warning
  added the new self enum value to the /// response property for the response status
- warning
  added the new single_family_house enum value to the /// response property for the response status
- warning
  added the new special_object enum value to the /// response property for the response status
- warning
  added the new vacation_condominium enum value to the /// response property for the response status
- warning
  added the new vacation_house enum value to the /// response property for the response status
- info
  removed the 2or3_family_house enum value from the /// response property for the response status
- info
  removed the agricultural_farm enum value from the /// response property for the response status
- info
  removed the building_plot_other enum value from the /// response property for the response status
- info
  removed the commercial_condominium enum value from the /// response property for the response status
- info
  removed the condominium enum value from the /// response property for the response status
- info
  removed the industrial_building enum value from the /// response property for the response status
- info
  removed the let enum value from the /// response property for the response status
- info
  removed the mixed_property enum value from the /// response property for the response status
- info
  removed the multi_family_house enum value from the /// response property for the response status
- info
  removed the office_building enum value from the /// response property for the response status
- info
  removed the residential_building_plot enum value from the /// response property for the response status
- info
  removed the self enum value from the /// response property for the response status
- info
  removed the single_family_house enum value from the /// response property for the response status
- info
  removed the special_object enum value from the /// response property for the response status
- info
  removed the vacation_condominium enum value from the /// response property for the response status
- info
  removed the vacation_house enum value from the /// response property for the response status

Operation history (22 revisions)