v50

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

Place a new mortgage application (serves as dossier)

Place a new application including all necessary information about the property and applicant's financial situation.

Note that in the case where the FI needs additional information on the property, the error response 400 must contain the minimum required JSON object (PropertyObject) as detail.

post/mortgages/applications

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

created.

idstring uuid required

Uuid v4 of the created resource.

Example response

{
  "id": "4bf92636-14a0-4511-98e2-acfde576e644"
}