v50

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-05-273145122.2 KB

Mortgage Application

Get the required property information for the specific FI needed for valuation

Show the subset of property details required by the FI for valuation.

get/mortgages/applications/required-information

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

OK.

propertyObjectIdstring required

The property object identifier defined by TPP.

buildingStandardBathroom'premium' | 'highlevel' | 'basic' | 'lowlevel'

Building standard of the sanitary installations.

buildingStandardFloorCoverings'premium' | 'highlevel' | 'basic' | 'lowlevel'

Building standard of the floor coverings.

buildingStandardKitchen'premium' | 'highlevel' | 'basic' | 'lowlevel'

Building standard of the kitchen.

ceilingHight'especially_high' | 'middle' | 'especially_low'

The ceiling hight in the rooms.

The class of property (Main residence, second residence, rented).

floorPlan'efficient' | 'average' | 'inefficient'

The efficiency of the floor plan.

heatEmissionstring[]

Type of the heat emission.

heatProductionstring[]

the way heat is generated within the building.

matrimonialPropertyScheme'jointEstate' | 'separateEstate' | 'contributionToJointlyAcquiredProperty'

Information how the property is owned.

namestring

User-defined property name.

outsideConstructionZoneboolean

If the property is outside of the construction zone.

The type of property.

publicNotarizationstring date

Date of public notarization.

remarksstring

Remark regarding the estimation.

transferOfOwnershipDatestring date

When the property will be fully transferred to the new owner.

usageType'self' | 'let'

The type of usage of the property: self, let.

valueRelevantServitudesboolean

If the property has servitudes true, else false.

Example response

{
  "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"
}