v50

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

Get document for the given order

Get document for given order, this can be used by TPP to display offer content.

get/mortgages/orders/{orderId}/document

Path parameters

orderIdstring uuid required

Uuid v4 of the order defined by FI.

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

Uuid v4 of an order.

Query parameters

language'de' | 'fr' | 'it' | 'en' required
Example:fr

Language of Document content.

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

{
  "document": {
    "name": "MortgageOffer_WaimerANON_587b23d1-12a8-475a-968b-abee245e3393",
    "content": "JVBERi0xLjQKJeLjz9MKMzEgMCBvYmoKPDwvQnl0ZVJhbmdl",
    "contentType": "application/octet-stream",
    "createDate": "2018-04-13",
    "modifyDate": "2018-04-13",
    "parentId": "2752ce81-5bf0-4991-89ac-87d6e7fd0c47"
  }
}