Mortgage Financing Request

List all required documents / information for processing specific Financial request at FI

All required documents for a specific FinancingRequestId can be retrieved herewith.

get/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/required-information

Request

Base URL
https://mortgage.common-api.ch
URL
https://mortgage.common-api.ch/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/required-information
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

applicationIdstring uuid required

The application identifier (UUID v4) defined by FI.

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

Uuid v4 of the application request.

financingRequestIdstring uuid required

Uuid v4 of the financing request defined by FI.

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

Uuid v4 of the financing request.

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.

OK.

documentsDocumentType[]

financingRequestIdstring uuid

{
  "documents": [
    "tax_statement"
  ],
  "financingRequestId": "550e8400-e29b-41d4-a716-446655440000"
}

Jul 28, 2025735bf0a87227 Revision changes
- info
  api operation id listApplicationFinancingRequestRequiredInformation was added
Jun 6, 202313f87d5f5f25 Revision changes
- breaking
  added the new path request parameter applicationId
- breaking
  added the new path request parameter financingRequestId
- warning
  deleted the path request parameter Application ID
- warning
  deleted the path request parameter Financing Request ID