---
title: "Get document for the given offer"
method: GET
path: "/mortgages/offers/{offerId}/document"
tags: ["Mortgage Offers"]
---

# Get document for the given offer

`GET /mortgages/offers/{offerId}/document`

## Request

- Base URL: `https://mortgage.common-api.ch`
- URL: `https://mortgage.common-api.ch/mortgages/offers/{offerId}/document`
- 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`

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

## Path parameters

- `offerId` string, uuid, required: Uuid v4 of the specific order.

## Query parameters

- `language` 'de' | 'fr' | 'it' | 'en', required

## Headers

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

## Response `200`

OK.

- object
  - `document` Document: Document containing information for given document type for given order.
    - `name` string, required: Name of the document.
    - `content` string: base64 Encoded Content.
    - `contentType` string: Content type.
    - `createDate` string, date: Date format.
    - `modifyDate` string, date: Date format.
    - `parentId` string, uuid: Id for parent object of given document.

## 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 `getOfferDocument` was added
- **2023-06-06** `13f87d5f5f25`: 1 breaking, 1 warning
  - added the new path request parameter `offerId`
  - deleted the `path` request parameter `Offer ID`
- **2023-03-13** `3661aeb7386e`: 1 breaking, 1 warning
  - added the new path request parameter `Offer ID`
  - deleted the `path` request parameter `offerId`
- **2022-11-04** `e7e09b626662`: 8 breaking
  - 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`
  - …4 more
- **2022-11-04** `1b28f88a9921`: 8 breaking
  - 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`
  - the `detail` response's property type changed from `array` to `string` for status `404`
  - …4 more

[Operation history](https://skmtc.dev/swissfintechinnovations/apis/common-mortgage-api-public-2/changes/mortgages/offers/:offerId/document/get.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)