Mortgage Application

Update the application's details

Changed on Aug 25, 2025

Update the application's details. Note that changing the application's details should not be possible after the application has been accepted by the FI.

put/mortgages/applications/{applicationId}

Request

Base URL
https://mortgage.common-api.ch
URL
https://mortgage.common-api.ch/mortgages/applications/{applicationId}
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

applicationIdstring uuid required

The application identifier (UUID v4) defined by FI.

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

Uuid v4 of the application request.

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.

Request body

mortgageType'buy' | 'replacement' | 'construction_financing' required

Type of business.

applicationIdstring uuid

The application identifier (UUID v4) defined by FI.

channelType'advisor' | 'direct'

The type of the channel the application was generated.

replacementType'entire' | 'partial'

NOT required when mortgage type is BUY, Values: entire, partial.

tppApplicationIdstring

The application alphanumeric identifier defined by TPP.

Example request

{
  "mortgageType": "buy",
  "propertyInformation": {
    "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"
  },
  "requestingParty": {
    "personList": [
      {
        "applicantDetail": {
          "name": "Max",
          "surName": "Muster",
          "address": {
            "country": "CH",
            "postCode": "CH-2501",
            "streetName": "Rue de la gare",
            "townName": "Biel",
            "buildingNumber": "24A"
          },
          "birthDate": "2018-04-13",
          "maritalStatus": "married",
          "PropertyOwner": "yes",
          "jobSituation": "employed",
          "nationality": "CH",
          "email": "max.muster@domain.ch",
          "phone": "+41443343456",
          "solvencyRating": {
            "ratingValue": 420,
            "ratingSourceType": "crif",
            "ratingDate": "2018-04-13"
          },
          "applicantLanguage": "fr",
          "gender": "female"
        },
        "applicantId": "576f8de3-6b30-4882-a7af-da2132a456cf",
        "applicantType": "individual",
        "fiApplicantId": "asd23f",
        "financialSituation": {
          "income": [
            {
              "incomeType": "employment_gross",
              "amount": {
                "content": "235.45",
                "currency": "CHF"
              },
              "remark": "We need an example for such a remark",
              "incomeProvider": "Employer AG"
            }
          ],
          "liabilities": [
            {
              "liabilityType": "mortgage",
              "amount": {
                "content": "235.45",
                "currency": "CHF"
              },
              "remark": "We need an example for such a remark",
              "liabilityProvider": "Leasing Firm AG"
            }
          ],
          "assets": [
            {
              "amount": {
                "content": "235.45",
                "currency": "CHF"
              },
              "assetType": "cash",
              "assetProvider": {
                "name": "Credit Suisse"
              },
              "insuranceSum": {
                "content": "235.45",
                "currency": "CHF"
              },
              "remark": "We need an example for such a remark"
            }
          ],
          "residentialSituation": "renter",
          "additionalProperties": [
            {
              "nameAdditionalProperty": "Orchard Villa, Holderstrasse 10",
              "valueAdditionalProperty": {
                "content": "235.45",
                "currency": "CHF"
              },
              "mortgageAmountAdditionalProperty": {
                "content": "235.45",
                "currency": "CHF"
              },
              "propertyTypeAdditionalProperty": "single_family_house",
              "usageTypeAdditionalProperty": "self"
            }
          ]
        }
      }
    ],
    "fiPrimaryApplicantId": "asd23f",
    "primaryApplicantId": "4bf92636-14a0-4511-98e2-acfde576e644"
  },
  "applicationId": "4bf92636-14a0-4511-98e2-acfde576e644",
  "channelType": "advisor",
  "replacedTranches": [
    {
      "replacedTrancheAmount": {
        "content": "235.45",
        "currency": "CHF"
      },
      "replacedTrancheExpiry": "2022-05-03",
      "replacedTrancheIssuer": "Credit Suisse"
    }
  ],
  "replacementType": "entire",
  "tppAdvisorDetail": {
    "name": "Max",
    "surName": "Muster",
    "nameTpp": "Muster Finanz AG",
    "email": "max.muster@domain.ch",
    "language": "fr",
    "phone": "+41443343456",
    "address": {
      "country": "CH",
      "postCode": "CH-2501",
      "streetName": "Rue de la gare",
      "townName": "Biel",
      "buildingNumber": "24A"
    }
  },
  "tppApplicationId": "asd23f"
}

Response

OK.

statusstring

Example response

{
  "status": "we need an example"
}

Changes

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

Operation history (27 revisions)