Mortgage Application
Update the real estate property's details
Changed onThis endpoint allows to upload a modified XML file in the SwissRETS format changing the already existing information.
put/mortgages/applications/{applicationId}/swissrets
Request
- Base URLhttps://mortgage.common-api.ch
- URLhttps://mortgage.common-api.ch/mortgages/applications/{applicationId}/swissrets
- Auth
- API key in header X-API-Key
- or OAuth 2Authorization code: https://example.com/oauth/authorizeToken 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
OK.
Example response
{
"status": "we need an example"
}Changes
- info
api operation id
updateApplicationInSwissretswas added
- info
- breaking
added the new path request parameter
applicationId - warning
deleted the
pathrequest parameterApplication ID
- breaking