v50

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

Mortgage Order

Place a new order

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.

post/mortgages/orders

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

offerIdstring uuid required

Uuid v4 of the specific order.

applicationIdstring uuid

The application identifier (UUID v4) defined by FI.

mortgageIdstring uuid

Uuid v4 of the mortgage.

orderIdstring uuid

Uuid v4 of the order defined by FI.

remarkstring

Remark/comment which can be added by TPP.

Example request

{
  "offerId": "4bf92636-14a0-4511-98e2-acfde576e644",
  "applicationId": "4bf92636-14a0-4511-98e2-acfde576e644",
  "mortgageId": "4bf92636-14a0-4511-98e2-acfde576e644",
  "orderId": "4bf92636-14a0-4511-98e2-acfde576e644",
  "remark": "All documents verified at TPP"
}

Response

created.

idstring uuid required

Uuid v4 of the created resource.

Example response

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