--- title: "Return a specific existing mortgage case" method: GET path: "/mortgage-cases/{caseId}" tags: ["Full Mortgage Cases"] --- # Return a specific existing mortgage case `GET /mortgage-cases/{caseId}` A specific existing mortgage case including the corresponding properties. ## Path parameters - `caseId` string, uuid, required — Uuid v4 of the mortgage case. ## Headers - `X-CorAPI-Client-ID` string, required - `X-Correlation-ID` string, required - `User-Agent` string, required ## Response `200` Mortgage case details with the corresponding properties. - object - `Case` MortgageCase — A complete mortgage case including the application details. - `application` Application, required — All static application information needed by the FI to create binding offers. - `mortgageType` 'buy' | 'replacement' | 'construction_financing', required — Type of business. - `propertyInformation` PropertyObject, required — The representation of a real estate object, real estate register id (propertyIdentifier) is optional until otherwise required by law. - `address` StructuredAddress, required — structured address. - `country` string, required — a political area, surrounded by borders, very often a natural border such as a river or a mountain. - `postCode` string, required — zip code. - `streetName` string, required — Name of street. - `townName` string, required — you guessed it, the name of the town. - `buildingNumber` string — number of building. - `propertyObjectId` string, required — The property object identifier defined by TPP. - `buildingRight` object — if a property is in building right, the buyer owner buy the property, not the ground the property is built on. - `hasBuildingRight` boolean — If the property is built in a building right true, else false. - `buildingRightExpiry` string, date — Date when the building right expires. - `buildingRightRent` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `buildingRightCompensation` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `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). - `collateralValue` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `estimation` object — the estimation of the value of a property. - `estimationId` string — ID of the property estimation to connect the done estimation in the core banking system with the estimation of the tpp in the external estimation tool. - `estimationSourceType` 'iazi' | 'wup' - `marketValue` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `statisticalPriceRangeMax` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `statisticalPriceRangeMin` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `yearlyRentalIncome` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `estimationDate` string, date — Date format. - `floorPlan` 'efficient' | 'average' | 'inefficient' — The efficiency of the floor plan. - `heatEmission` string[] — Type of the heat emission. - `heatProduction` string[] — the way heat is generated within the building. - `investmentCost` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `limitForLandEncumbrances` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `matrimonialPropertyScheme` 'jointEstate' | 'separateEstate' | 'contributionToJointlyAcquiredProperty' — Information how the property is owned. - `name` string — User-defined property name. - `objectPrice` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `outsideConstructionZone` boolean — If the property is outside of the construction zone. - `propertyBuildingInformation` object — The property building information. - `livingSpace` object - `livingSpaceInSqm` integer — The area of the living space in quatermeter. - `measurementStandard` 'nla' | 'gfa' — The measurement standard used to determine the living space (nla or gfa). - `roofFloorExpandable` boolean — If the roof floor is expandable true, else false. - `volumeIncludingGarageInhouse` integer — The volume of the house including the inhouse garage (relevant for WuP). - `volumeIncludingAllGarages` integer — The volume of the house including all inhouse and external garages and garage boxes (relevant for IAZI). - `landArea` integer — The surface area of the land. - `environmentStandard` 'high-level' | 'basic' | 'low-level' — The rating type. - `otherFeatures` string[] - `houseType` 'detached_house' | 'semidetached_house' | 'row_house' | 'row_corner_house' | 'terrace_house' — The type of the house. - `normType` 'building_insurance' | 'sia116' | 'sia416' | 'other' — The norm type. - `propertyConstructionInformation` object — The property construction information. - `constructionYear` integer — construction year. - `renovation` boolean — If the property is renovated true, else false. - `renovationYear` integer — renovation year. - `propertyRenovations` object[] - `refurbishmentComponentType` 'total' | 'interior_fittings_kitchen' | 'interior_fittings_bathroom_sanitary' | 'interior_fittings_floor_cover' | 'interior_fittings_remaining' | 'building_envelope_pitched_roof' | 'building_envelope_flat_roof' | 'building_services_heat_production' | 'building_services_heat_emission' | 'buildings_services_electrical_ventilation_elevator' | 'work_on_surroundings' | 'supporting_structure' | 'building_envelope_windows' | 'building_envelope_facade_balcony' | 'interior_fittings' | 'building_envelope' | 'building_services' — Type of Property Component which has been renovated. Please use consistently either the detailed Component types (e.g. interior_fittings_floor_cover) or the simple Component Types (e.g. interior_fittings). - `yearOfRenovation` integer — renovation year. - `renovationCost` Amount — amount with currency. - … - `minergieStandardType` 'none' | 'minergie' | 'minergie-p' | 'minergie-eco' | 'minergie-p-eco' | 'minergie-a' | 'minergie-a-eco' — The minergie standard. - `BECCStandardType` 'none' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' — Energy certificate from Cantons. - `luxusFlag` '0' | '0.5' | '1.0' — Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: - '0' = No - '0.5' = Partially - '1' = Yes Proposed Mapping of WuP-Values: - 1.0-4.0 => 0 (No) - 4.1-4.5 => 0.5 (Partially) - 4.6-5.0 => 1.0 (Yes) - `constructionQualityType` 'bad' | 'bad-medium' | 'medium' | 'medium-good' | 'good' | 'good-verygood' | 'verygood' — The rating type. - `stateBuildingType` 'bad' | 'bad-medium' | 'medium' | 'medium-good' | 'good' | 'good-verygood' | 'verygood' — The rating type. - `propertyElements` object — The property detail information such as rooms count, parking places. - `numberOfRooms` number, double — The number of the rooms. - `numberOfRoomsInGrannyFlat` number, double — The number of the rooms in the granny flat. - `roomCountType` 'kitchen_not_counted' | 'kitchen_half_room' | 'kitchen_full_room' — Reflects the type of the room count type. E.g. if the kitchen counts as full room. - `numberOfFamilyBathrooms` integer — Separate shower and bathtub in the bathroom (optional: toilet). - `numberOfBathWC` integer — Bath or shower, sink, toilet. - `numberOfGuestWC` integer — Separate, single toilet with wash basin. - `numberOfExternalParking` integer — The number of external parking spaces. - `numberOfSeparateGarages` integer — The number of separated garages (covered parking spaces), which are located on the same property but are not included in the building volume of the house (separate building insurance policy). - `numberOfExternalSeparateGarages` integer — The number of separated garages (covered parking spaces). - `numberOfAttachedGarages` integer — The number of garages which are attached to the house and which are included in the building volume of the house (don't have a separate building insurance policy). - `numberOfUndergroundCarParks` integer — The number of underground parking places. - `propertyFlatInformation` object — The property flat information. - `numberOfFlats` integer — The number of flats in the building. - `numberOfFloors` integer — The number of floors in the building. - `stateApartmentType` 'bad' | 'bad-medium' | 'medium' | 'medium-good' | 'good' | 'good-verygood' | 'verygood' — The rating type. - `floor` integer — The floor of the flat. - `balconyOrTerraceArea` integer — The area of the balcony or terrace in quatermeter. - `livingSpace` object - `livingSpaceInSqm` integer — The area of the living space in quatermeter. - `measurementStandard` 'nla' | 'gfa' — The measurement standard used to determine the living space (nla or gfa). - `multistorey` boolean — If the flat is multistorey true, else false. - `otherFeatures` string[] - `quote` integer — The quote of the flat property against the whole building property. - `apartmentType` 'garden_flat' | 'floor_flat' | 'roof_flat' | 'attic' — The type of the apartment (floor, garden level, storey). - `buildingType` 'multiple_family_house' | 'terrace_house' — The type of the building (multiple_family_house, terrace_house). - `locationInTheBuildingRating` 'bad' | 'bad-medium' | 'medium' | 'medium-good' | 'good' | 'good-verygood' | 'verygood' — The rating type. - `propertyIdentifier` PropertyIdentifier — Property identification (register of real estate). - `EGID` string — Identifier of the property. - `EGRID` string — Identifier of land a property is built on. - `EWID` string — Identifier of the apartment. - `propertyLinks` Link[] — A list of links to external resources related to the property. - `url` string, uri, required — The URL pointing to the resource. - `description` string — A description of the resource. - `name` string — The name of the resource. - `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. - `publicNotarization` string, date — Date of public notarization. - `remarks` string — Remark regarding the estimation. - `renovationAmount` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `transferOfOwnershipDate` string, date — When the property will be fully transferred to the new owner. - `usageType` 'self' | 'let' — The type of usage of the property: self, let. - `valueRelevantServitudes` boolean — If the property has servitudes true, else false. - `requestingParty` Party, required — Links together the persons building the applicant party. - `personList` Applicant[], required — .. - `applicantDetail` object, required — personal information regarding the applicant. - `name` string — Name of the applicant. - `surName` string — Surname of the applicant. - `address` StructuredAddress — structured address. - … - `birthDate` string, date — Date format. - `maritalStatus` 'unmarried' | 'married' | 'divorced' | 'widowed' | 'registered-partnership' | 'legally-separated' | 'partnership-dissolved' — Martial status of the applicant. - `PropertyOwner` 'yes' | 'no' — Is the applicant owner of the financed property? Yes/No. - `jobSituation` 'employed' | 'selfEmployed' | 'unemployed' | 'retired' — Job situation of the applicant. - `nationality` string — 2-Letter ISO 3166-2 Country Code. - `USPerson` boolean — Is the applicant a US person. - `email` string — Email of the applicant. - `phone` string — Phone number of the applicant. - `solvencyRating` object — Solvency rating of the applicant e.g. CRIF. - … - `applicantLanguage` 'de' | 'fr' | 'it' | 'en' — Preferred contact language of the applicant. - `gender` 'male' | 'female' | 'other' — Gender of the applicant. - `applicantId` string, uuid, required — UUID v4 of the applicant (to be defined by TPP). - `applicantType` 'individual' | 'legal_entity', required — type of applicant. - `fiApplicantId` string — ApplicantId of the applicant party defined by the financial institute, only applicable if known at the moment of the application. - `financialSituation` object — the overall financial situation of a debtor. - `income` object[] - … - `liabilities` object[] - … - `assets` Asset[] - … - `residentialSituation` 'home_owner' | 'renter' - `additionalProperties` object[] - … - `fiPrimaryApplicantId` string — ApplicantId for primary applicant of the applicant party defined by the financial institute, only applicable in case of multiple applicants and if known at the moment of the application. - `primaryApplicantId` string, uuid — ApplicantId for primary applicant of the applicant party. In case of multiple applicants this field is mandatory. - `applicationId` string, uuid — The application identifier (UUID v4) defined by FI. - `channelType` 'advisor' | 'direct' — The type of the channel the application was generated. - `replacedTranches` object[] — Tranche to be replaced. - `replacedTrancheAmount` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `replacedTrancheExpiry` string, date — The expiry date of the replaced tranche. - `replacedTrancheIssuer` string — The institute who has issued the replaced tranche. - `replacementType` 'entire' | 'partial' — NOT required when mortgage type is BUY, Values: entire, partial. - `tppAdvisorDetail` object — Personal information if the advisor of the TPP. - `name` string — Name of the TPP advisor. - `surName` string — Surname of the TPP advisor. - `nameTpp` string — Firm of the TPP advisor. - `email` string — Email of the TPP advisor. - `language` 'de' | 'fr' | 'it' | 'en' — Preferred contact language of the TPP advisor. - `phone` string — phone of the TPP advisor. - `address` StructuredAddress — structured address. - `country` string, required — a political area, surrounded by borders, very often a natural border such as a river or a mountain. - `postCode` string, required — zip code. - `streetName` string, required — Name of street. - `townName` string, required — you guessed it, the name of the town. - `buildingNumber` string — number of building. - `tppApplicationId` string — The application alphanumeric identifier defined by TPP. - `caseId` string, uuid, required — Uuid v4 of the mortgage case. - `financing` Financing, required — Complete financing details of an application. - `amount` Amount, required — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `amortizations` Amortizations — Information about the amortization on mortgage or on tranche level. - `amortizationAccountNr` string — The account number from which the amortization is paid. - `amortizationAmount` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `amortizationPeriodicity` 'yearly' | 'quarterly' | 'monthly' — The periodicity the amortization is paid. - `amortizationStart` string, date — Start date of amortization. - `amortizationType` 'direct' | 'indirect' — The type of amortization. - `applicationIdRef` string, uuid — Uuid of the financing's corresponding application. - `financingId` string, uuid — Uuid of the financing. - `increaseAmount` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `increasePurpose` string — The purpose of the increase. - `offerDate` string, date — Date format. - `publicCertDate` string, date — Date format. - `tranches` FinancingTranche[] — mortgage tranches. - `amount` Amount, required — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `interest` Interest, required — The current rate and optionally the referred base. - `currentRate` number, double, required — Interest rate in decimals. 2.45% would be sent as 0.0245. For flexible interest mortgage this would show the margin above interest. - `base` number, double — Base rate upon margin is applied (e.g. for SARON). - `interestRateType` 'variable' | 'libor' | 'saron' | 'fixed', required — type of interest rate. - `payoutDate` string, date, required — Date format. - `amortizations` Amortizations — Information about the amortization on mortgage or on tranche level. - `amortizationAccountNr` string — The account number from which the amortization is paid. - `amortizationAmount` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `amortizationPeriodicity` 'yearly' | 'quarterly' | 'monthly' — The periodicity the amortization is paid. - `amortizationStart` string, date — Start date of amortization. - `amortizationType` 'direct' | 'indirect' — The type of amortization. - `duration` integer — duratin of the mortgage in years. - `maturityDate` string, date — Date format. - `productIdRef` string, uuid — Uuid of the product. - `saronperiod` '1m' | '3m' | '6m' | '12m' — The saron period. - `usedAssets` UsedAsset[] — used assets. - `amount` Amount, required — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `applicantId` string, uuid, required — UUID v4 of the applicant (existing applicant within the current application). - `assetType` 'cash' | 'gift' | 'reservation_deposit' | 'advancement_of_inheritance' | 'third_pillar' | 'third_pillar_3a' | 'third_pillar_3b' | 'pension_fund' | 'third_party_loan' | 'third_pillar_fund' | 'third_pillar_fund_3b' | 'third_pillar_fund_3a' | 'fungible_investments' | 'other' | 'vested_benefit' | 'life_insurance_3a' | 'life_insurance_3b' | 'unpledged_building_plot', required — Common set of asset types. - `assetProvider` AssetProvider — Asset provider for each asset, additional information must be transferred. E.g. in case the applicant owns an additional security of type insurance, insurance company name is provided - `name` string, required — Name of the asset provider. - `insuranceSum` Amount — amount with currency. - `content` string, required — amount given with fractional digits, the separator is a dot. - `currency` string, required — ISO 4217 code. - `usageType` 'pledged' | 'withdraw' — Common set of asset usage types. - `remark` string — Remark/comment which can be added by TPP. ## Other responses - `400` — Bad Request - The server cannot or will not process the request due to something that is perceived to be a client error as malformed request syntax. - `401` — Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource. - `403` — Forbidden - The server understood the request but refuses to authorize it. - `404` — Not Found - The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. - `405` — Method Not Allowed - The method received in the request-line is known by the origin server but not supported by the target resource. - `500` — Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request. - `501` — Not Implemented - The server does not support the functionality required to fulfill the request. - `503` — Service Unavailable - The server is currently unable to handle the request due to a temporary overload or scheduled maintenance. --- [API](https://skmtc.net/swissfintechinnovations/apis/common-mortgage-api-public-2.md) · [All operations](https://skmtc.net/swissfintechinnovations/apis/common-mortgage-api-public-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/swissfintechinnovations/common-mortgage-api-public-2/revisions/32dae0ff8520/schema)