---
title: "Place a new order"
method: POST
path: "/mortgages/orders"
tags: ["Mortgage Order"]
---

# Place a new order

`POST /mortgages/orders`

## Request

- Base URL: `https://mortgage.common-api.ch`
- URL: `https://mortgage.common-api.ch/mortgages/orders`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2
    - Authorization code: `https://example.com/oauth/authorize`
    - Token URL: `https://example.com/oauth/token` scopes: `read`, `write`

Place a new order referencing a specific offerId and either an existing mortgage id (prolongation) or an application id (new
mortgage) including all relevant information.

## Headers

- `X-CorAPI-Client-ID` string, required
- `X-Correlation-ID` string, required
- `User-Agent` string, required

## Request body

- Order: All information needed to choose a specific offer and place a binding order.
  - `offerId` string, uuid, required: Uuid v4 of the specific order.
  - `applicationId` string, uuid: The application identifier (UUID v4) defined by FI.
  - `mortgageId` string, uuid: Uuid v4 of the mortgage.
  - `orderId` string, uuid: Uuid v4 of the order defined by FI.
  - `remark` string: Remark/comment which can be added by TPP.

## Response `201`

created.

- CommonResourceCreatedResponse: Uuid v4 of the created resource.
  - `id` string, uuid, required: Uuid v4 of the created resource.

## 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.

## Changes

- **2025-07-28** `735bf0a87227`: 1 info
  - api operation id `addOrder` was added
- **2022-11-04** `e7e09b626662`: 8 breaking, 1 warning, 1 info
  - the `detail` response's property type changed from `string` to `array` for status `400`
  - the `detail` response's property type changed from `string` to `array` for status `401`
  - the `detail` response's property type changed from `string` to `array` for status `403`
  - the `detail` response's property type changed from `string` to `array` for status `404`
  - …6 more
- **2022-11-04** `1b28f88a9921`: 9 breaking, 1 info
  - removed the media type `application/json` for the response with the status `201`
  - the `detail` response's property type changed from `array` to `string` for status `400`
  - the `detail` response's property type changed from `array` to `string` for status `401`
  - the `detail` response's property type changed from `array` to `string` for status `403`
  - …6 more
- **2022-11-03** `301ce6b46d3e`: 1 warning
  - removed the request property `validateOnly`
- **2022-11-03** `7737aa2815e0`: 8 breaking, 1 info
  - the `detail` response's property type changed from `string` to `array` for status `400`
  - the `detail` response's property type changed from `string` to `array` for status `401`
  - the `detail` response's property type changed from `string` to `array` for status `403`
  - the `detail` response's property type changed from `string` to `array` for status `404`
  - …5 more

[Operation history](https://skmtc.dev/swissfintechinnovations/apis/common-mortgage-api-public-2/changes/mortgages/orders/post.md)

---

[API](https://skmtc.dev/swissfintechinnovations/apis/common-mortgage-api-public-2.md) - [All operations](https://skmtc.dev/swissfintechinnovations/apis/common-mortgage-api-public-2/llms.txt) - [OpenAPI document](https://skmtc.dev/swissfintechinnovations/apis/common-mortgage-api-public-2/revisions/32dae0ff8520?raw)