SWswissfintechinnovations
Mortgage Financing Request

Get the details of a financing request

Changed on

Get a specific financing request based on the financingRequestId.

get/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}
  • 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

applicationIdstring uuid required

The application identifier (UUID v4) defined by FI.

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

Uuid v4 of the application request.

financingRequestIdstring uuid required

Uuid v4 of the financing request defined by FI.

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

Uuid v4 of the financing request.

Query parameters

cursorstring
Example:cursorIDxyz

Optional parameter for pagination. An opaque string value used for pagination.

limitinteger
Example:25

Optional parameter for pagination. Maximum number of entries to be returned.

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

{
  "offerList": [
    {
      "amount": {
        "content": "235.45",
        "currency": "CHF"
      },
      "applicationId": "4bf92636-14a0-4511-98e2-acfde576e644",
      "financingRequestId": "4bf92636-14a0-4511-98e2-acfde576e644",
      "increaseAmount": {
        "content": "235.45",
        "currency": "CHF"
      },
      "increasePurpose": "renovation of the kitchen",
      "publicCertDate": "2018-04-13",
      "requestOfferType": "binding",
      "tranches": [
        {
          "trancheId": "51b017e1-5e59-4b58-a0a0-c638c87db463",
          "productId": "4bf92636-14a0-4511-98e2-acfde576e644",
          "productVariation": {
            "duration": 5,
            "rate": 0.5,
            "saronperiod": "3m"
          },
          "payOutDate": "2018-04-13",
          "amount": {
            "content": "235.45",
            "currency": "CHF"
          }
        }
      ],
      "usedAssets": [
        {
          "amount": {
            "content": "235.45",
            "currency": "CHF"
          },
          "applicantId": "576f8de3-6b30-4882-a7af-da2132a456cf",
          "assetType": "cash",
          "assetProvider": {
            "name": "Credit Suisse"
          },
          "insuranceSum": {
            "content": "235.45",
            "currency": "CHF"
          },
          "usageType": "pledged"
        }
      ]
    }
  ]
}

Changes

  • 735bf0a87227Revision changes
    • info

      api operation id getApplicationFinancingRequest was added

  • 990b493a4a31Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      the response property became required for the status