v50

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-05-273145122.2 KB
Mortgage Offers

List all required documents / information for processing specific offer at FI

Lists the required documents for the previously submitted case. Thus, the TPP knows which documents are needed for the later check.

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

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.

financingRequestIdstring uuid required

Uuid v4 of the financing request defined by FI.

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

Uuid v4 of the financing request.

offerIdstring uuid required

Uuid v4 of the specific order.

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

Uuid v4 of the offer.

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.

documentsDocumentType[]
offerIdstring uuid

Example response

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