SWswissfintechinnovations
Mortgage Order

Place a new order

Changed on

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

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/orders
  • 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

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"
}

Changes

  • 735bf0a87227Revision changes
    • info

      api operation id addOrder was added

  • e7e09b626662Revision changes
    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      the response's property type changed from string to array for status

    • warning

      removed the request property

    • info

      added the media type application/json for the response with the status