3.2 Use Cases

For more (technical) information about the mortgage API, please visit Common API GitHub.

Diagram

 

Use Case Category - Existing Mortgages

 

Customer Core Use Cases

  • Show my existing mortgages

  • Show current offers for my expiring mortgages

TPP Functionality

  • List of all my mortgages incl. corresponding properties

  • Get a specific mortgage

  • List of all offers for a specific expiring mortgage

  • Get a specific offer for an expiring mortgage

FI API Path

  • /mortgages/v[x]

(e.g. /mortgages/v1 where v1 is the major version 1 of the API)

Use Case Category - Mortgages Application

Customer Core Use Cases

  • Place a new mortgage application

  • Manage a mortgage application

  • Get offers for new mortgage applications

  • Get indicative offers for mortgages without customer-identifying data

  • Get mortgage documents from FI

TPP Functionality

  • Place a new mortgage application

  • Get details of a specific application

  • Add documents for a specific application

  • Delete a formerly uploaded document

  • Get the current status of an application

  • Add SwissRETS property details

  • Place a financing-request for a specific application

  • List all binding offers for a given financing request

  • Get the details of a specific offer of a given financing request

  • Get information list, the specific FI needs for valuation

FI API Path

  • /mortgages/v[x]/applications

(e.g. /mortgages/v1/applications where v1 is the major version 1 of the API)

Use Case Category - Products & Orders

Customer Core Use Cases

  • Get an overview of all mortgages products (general information & conditions)

  • Place and manage mortgage orders

TPP Functionality

  • Place a new order

  • Get the details of a specific placed order

  • Get the current status of an order

  • Get a list of all mortgage products

  • Get the general conditions for the specified mortgage product

FI API Paths

  • /mortgages/v[x]/orders

  • /mortgages/v[x]/products

(e.g. /mortgages/v1/orders where v1 is the major version 1 of the API)