SWswissfintechinnovations
Mortgage Application

Delete a formerly uploaded document

Changed on

Deletes a specific document attached to a specific application. Note that deleting documents should not be possible after the application has been accepted by the FI.

delete/mortgages/applications/{applicationId}/documents/{documentId}

Request

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

documentIdstring uuid required

Unique ID (uuid v4) of the document.

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

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.

statusstring

Example response

{
  "status": "we need an example"
}

Changes

  • 735bf0a87227Revision changes
    • info

      api operation id deleteApplicationDocument was added

  • 13f87d5f5f25Revision changes
    • breaking

      added the new path request parameter applicationId

    • breaking

      added the new path request parameter documentId

    • warning

      deleted the path request parameter Application ID

    • warning

      deleted the path request parameter Document ID