SWswissfintechinnovations
Mortgage Order

Get the details of a specific placed order

Changed on

Get the details of a specific placed order.

get/mortgages/orders/{orderId}

Request

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

Path parameters

orderIdstring uuid required

Uuid v4 of the order defined by FI.

Example:4bf92636-14a0-4511-98e2-acfde576e644

Uuid v4 of an order.

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.

Response

OK.

Example response

{
  "offer": {
    "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"
  }
}

Changes