SWswissfintechinnovations
Mortgage Application

Get the current status of the application

Changed on

Get the current status of the application (rejected with reason, accepted, pending with reason).

get/mortgages/applications/{applicationId}/status

Request

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

Response

OK.

detailstring

Additional information that can be shared with the status.

status'accepted' | 'rejected' | 'pending'

Example response

{
  "detail": "Waiting for details",
  "status": "pending"
}

Changes