SWswissfintechinnovations
Mortgage Application

Add property details in the SwissRETS standard

Changed on

This endpoint allows to upload the real estate property's details as an XML file in the SwissRETS format according to https://swissrets.ch/.

post/mortgages/applications/{applicationId}/swissrets

Request

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

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.

Request body application/xml

string required

Response

created.

idstring uuid required

Uuid v4 of the created resource.

Example response

{
  "id": "4bf92636-14a0-4511-98e2-acfde576e644"
}

Changes