--- title: "Get the details of a specific offer" method: GET path: "/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/offers/{offerId}" tags: ["Mortgage Offers"] --- # Get the details of a specific offer `GET /mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/offers/{offerId}` ## Request - Base URL: `https://mortgage.common-api.ch` - URL: `https://mortgage.common-api.ch/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/offers/{offerId}` - 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 the details of a specific offer for a specific placed application. ## Path parameters - `applicationId` string, uuid, required: The application identifier (UUID v4) defined by FI. - `financingRequestId` string, uuid, required: Uuid v4 of the financing request defined by FI. - `offerId` string, uuid, required: Uuid v4 of the specific order. ## Headers - `X-CorAPI-Client-ID` string, required - `X-Correlation-ID` string, required - `User-Agent` string, required ## Response `200` OK. - object - `offer` Offer: All relevant details describing the FI's offer for a mortgage product. - `financingRequestId` string, uuid, required: Uuid v4 of the financing request defined by FI. - `offerId` string, uuid, required: Uuid v4 of the specific order. - `offerItems` OfferItem[], required: .. - `offerItemId` string, uuid, required: Uuid v4 of the specific offer item. - `product` Product, required: All details regarding an FI's mortgage product. - `interestRateType` 'variable' | 'libor' | 'saron' | 'fixed', required: type of interest rate. - `names` object[], required: name of mortgage product. - `description` string: Product name description. - `language` 'de' | 'fr' | 'it' | 'en': Language of product name. - `productId` string, uuid, required: Uuid of the product. - `productVariations` ProductVariation[]: .. - `duration` integer: The duration in years. - `rate` number, double: The interest rate. - `saronperiod` '1m' | '3m' | '6m' | '12m': The saron period. - `trancheId` string, uuid, required: Uuid of the tranche. - `conditions` Condition[]: .. - `amortization` integer, required: the amount of repayment. - `amountRange` AmountRange, required: Min and max amount with currency. - `currency` string, required: ISO 4217 code. - `maxContent` string, required: max amount given with fractional digits, the separator is a dot. - `minContent` string, required: min amount given with fractional digits, the separator is a dot. - `conditionId` string, uuid, required: ID of condition. - `duration` integer, required: The duration in years. - `interest` Interest, required: The current rate and optionally the referred base. - `currentRate` number, double, required: Interest rate in decimals. 2.45% would be sent as 0.0245. For flexible interest mortgage this would show the margin above interest. - `base` number, double: Base rate upon margin is applied (e.g. for SARON). - `maturityDate` string, date, required: Date format. - `productIdRef` string, uuid, required: Reference to product ID. - `amortizations` Amortizations: Information about the amortization on mortgage or on tranche level. - `amortizationAccountNr` string: The account number from which the amortization is paid. - `amortizationAmount` Amount: amount with currency. - `content` string, required: amount given with fractional digits, the separator is a dot. - `currency` string, required: ISO 4217 code. - `amortizationPeriodicity` 'yearly' | 'quarterly' | 'monthly': The periodicity the amortization is paid. - `amortizationStart` string, date: Start date of amortization. - `amortizationType` 'direct' | 'indirect': The type of amortization. - `totalAmount` Amount, required: amount with currency. - `content` string, required: amount given with fractional digits, the separator is a dot. - `currency` string, required: ISO 4217 code. - `validTo` string, date, required: Date format. - `offerType` 'binding' | 'indicative': type of offer (binding or indicative). ## 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 `getApplicationFinancingRequestOffer` was added - **2023-06-06** `13f87d5f5f25`: 3 breaking, 3 warning - added the new path request parameter `applicationId` - added the new path request parameter `financingRequestId` - added the new path request parameter `offerId` - deleted the `path` request parameter `Application ID` - …2 more - **2023-05-15** `895a72990bc3`: 7 info - the `offer/offerItems/items/conditions/items/amortizations/amortizationAmount/content` response's property pattern was changed from `-?\d{1,14}(?:\.\d{1,3})?` to `^-?\d{1,14}(?:\.\d{1,3})?$` for the status `200` - the `offer/offerItems/items/conditions/items/amortizations/amortizationAmount/currency` response's property pattern was changed from `[A-Z]{3}` to `^[A-Z]{3}$` for the status `200` - the `offer/offerItems/items/conditions/items/amountRange/currency` response's property pattern was changed from `[A-Z]{3}` to `^[A-Z]{3}$` for the status `200` - the `offer/offerItems/items/conditions/items/amountRange/maxContent` response's property pattern was changed from `-?\d{1,14}(?:\.\d{1,3})?` to `^-?\d{1,14}(?:\.\d{1,3})?$` for the status `200` - …3 more - …earlier changes not shown [Operation history](https://skmtc.dev/swissfintechinnovations/apis/common-mortgage-api-public-2/changes/mortgages/applications/:applicationId/financing-requests/:financingRequestId/offers/:offerId/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)