SWswissfintechinnovations
Mortgage Application

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

Changed on

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

get/mortgages/applications/required-information

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/applications/required-information
  • 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

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.

classOfProperty'main_residence' | 'main_residence_with_use_restriction' | 'second_residence' | 'second_residence_with_use_restriction' | 'rented_property' | 'rented_property_with_use_restriction' | 'other'

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.

propertyType'single_family_house' | 'condominium' | 'vacation_house' | 'vacation_condominium' | 'agricultural_farm' | '2or3_family_house' | 'multi_family_house' | 'residential_building_plot' | 'building_plot_other' | 'mixed_property' | 'commercial_condominium' | 'office_building' | 'industrial_building' | 'special_object'

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

Changes

  • 5d5a42b0d072Revision 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

  • ec48626881ddRevision 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