Overview

As a loan provider get all the data of your applications for highly effective validations and approvals.

Version information

Version : 2.76

Contact information

Contact : Europace AG
Contact Email : devsupport@europace2.de

URI scheme

Host : baufismart.api.europace.de
BasePath : /
Schemes : HTTPS

Tags

  • Antraege : All about mortage-applications and -approvals.

Security

Bearer

Type : apiKey
Name : Authorization
In : HEADER

OAuth2

Type : oauth2
Flow : application
Token URL : https://api.europace.de/auth/access-token

Name Description

baufinanzierung:echtgeschaeft

to use api in production mode

baufinanzierung:antrag:lesen

to get application information

baufinanzierung:antrag:schreiben

to update application data (eg state, loan office and own reference)

Resources

Antraege

All about mortage-applications and -approvals.

get list of all applications

GET /v2/antraege
Description

As loan provider, you’ll get a list of all your applications, sorted by lastChanged, paged and filterable.

Parameters
Type Name Description Schema Default

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Query

aenderungBis
optional

filter by changes until, date as ISO Format UTC - Zulu

string

Query

aenderungSeit
optional

filter by changes since, date as ISO Format UTC - Zulu

string

Query

angenommenNach
optional

filter by created after, date as ISO Format UTC - Zulu

string

Query

angenommenVor
optional

filter by created before, date as ISO Format UTC - Zulu

string

Query

antragsReferenz
optional

filter by your own reference

string

Query

datenKontext
optional

usage mode

enum (ECHT_GESCHAEFT, TEST_MODUS)

"ECHT_GESCHAEFT"

Query

limit
optional

limit

integer (int32)

10

Query

page
optional

page

integer (int32)

0

Query

produktAnbieter
optional

filter by loan provider

string

Query

sort
optional

sort mode, default descending

string

"absteigend"
Responses
HTTP Code Description Schema

200

OK

Antraege

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

get list of all applications of a case

GET /v2/antraege/{vorgang}
Description

As advisor, you’ll get a list of all applications of your case.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

vorgang
required

case-id

string
Responses
HTTP Code Description Schema

200

OK

Antraege

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

get list of approvals of an application

GET /v2/antraege/{vorgang}/{antrag}
Description

As loan Provider, you’ll get a list of approvals with data for validation and decision.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

vorgang
required

case-id

string
Responses
HTTP Code Description Schema

200

OK

Antraege

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

get application

GET /v2/antraege/{vorgang}/{antrag}/{teilantrag}
Description

As loan Provider, you’ll get all data of an application for validation and decision.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

iterator-application

integer (int32)

Path

vorgang
required

case-id

string
Responses
HTTP Code Description Schema

200

OK

Antrag

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

patch application

PATCH /v2/antraege/{vorgang}/{antrag}/{teilantrag}
Description

As loan provider, update the planned approving date, the loan officer contact details and your own reference for well informed advisors and easy conversations with sales.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

approval-iterator

integer (int32)

Path

vorgang
required

case-id

string

Body

patchOperations
required

patchOperations

< PatchOperation > array
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json-patch+json

  • application/json

Produces

  • */*

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:schreiben

get offer

GET /v2/antraege/{vorgang}/{antrag}/{teilantrag}/angebot
Description

As loan provider, you’ll get all loan details wich are accepted by the customer.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

approval-iterator

integer (int32)

Path

vorgang
required

case-id

string
Responses
HTTP Code Description Schema

200

OK

AngebotZumAntrag

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

get redemption plan

GET /v2/antraege/{vorgang}/{antrag}/{teilantrag}/angebot/zahlungsplaene
Description

As loan provider, you’ll get a redemption plan of the loan.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

approval-iterator

integer (int32)

Path

vorgang
required

case-id

string
Responses
HTTP Code Description Schema

200

OK

Zahlungsplaene

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

get clerk

GET /v2/antraege/{vorgang}/{antrag}/{teilantrag}/ansprechpartner
Description

As loan provider, you’ll get the contact details of the clerk for communication.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

application-id

integer (int32)

Path

teilantrag
required

iterator-application

integer (int32)

Path

vorgang
required

case-id

string
Responses
HTTP Code Description Schema

200

OK

Partner

400

Client Error

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

422

Unprocessable Entity

Error

500

Internal Server Error

Error
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:lesen

create counteroffer

POST /v2/antraege/{vorgang}/{antrag}/{teilantrag}/gegenangebot
Description

As loan provider, you can resend an adjusted offer, to create a working solution for the customer.

A counteroffer is an adjusted offer based on the application set by the loan provider.

If a counteroffer is created, the original offer will be marked as 'ABGELEHNT' and a new offer will be created. The new offer is automatically marked as `UNTERSCHRIEBEN ` from the loan provider.

A single loan or a combination of loans can be offered as a counteroffer.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

approval-iterator

integer (int32)

Path

vorgang
required

case-id

string

Body

gegenangebot
required

gegenangebot

Gegenangebot
Responses
HTTP Code Description Schema

201

Created

string

400

Client Error

Problem

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:schreiben,baufinanzierung:echtgeschaeft

send message

POST /v2/antraege/{vorgang}/{antrag}/{teilantrag}/nachricht
Description

As loan provider, you can send a message to the advisor to communicate without a denied-state.

Important! Please prefer set state for communication with advisor, because states are more helpful for process reporting.

This method should be your last choice.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

iterator-application

integer (int32)

Path

vorgang
required

case-id

string

Body

nachrichtDTO
required

nachrichtDTO

NachrichtDTO
Responses
HTTP Code Description Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:schreiben

set state

POST /v2/antraege/{vorgang}/{antrag}/{teilantrag}/status
Description

As loan provider, you can set a state for an application to inform the advisor about your descision.

If you set a state for an application the adivsor will be automatically informed by your descision and message. You can use it, to send advisor a message if you choose the right state and use the property kommentar.

Parameters
Type Name Description Schema

Header

Authorization
optional

Bearer {access-token}

string

Header

X-Authentication
optional

Deprecated. Pls use https://docs.api.europace.de/common/authentifizierung/authorization-api/

string

Header

X-TraceId
optional

your request id, https://docs.api.europace.de/common/tracing/

string

Path

antrag
required

iterator-solution

integer (int32)

Path

teilantrag
required

iterator-application

integer (int32)

Path

vorgang
required

case-id

string

Body

statusDTO
required

statusDTO

StatusDTO
Responses
HTTP Code Description Schema

201

Created

No Content

202

Accepted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

OAuth2

baufinanzierung:antrag:schreiben

Definitions

Absicherung

Name Schema

abgesicherteRisiken
optional

< RisikoAbsicherung > array

externeAngebotsNummer
optional

string

gesamtPraemie
optional

number

praemienZahlungsweise
optional

enum (EINMALIG, HALBJAEHRLICH, JAEHRLICH, MONATLICH, VIERTELJAEHRLICH)

tarifBezeichnung
optional

string

tarifKennung
optional

string

versichertePersonId
optional

string

versicherungsArt
optional

string

versicherungsNummer
optional

string

versicherungsZeitraum
optional

VersicherungsZeitraum

AbsicherungsAngaben

Name Description Schema

betraegtWoechentlicheArbeitsZeitMindestens15Stunden
optional

TRUE if is working more than 15 hours per week

boolean

AngebotZumAntrag

offer details

Name Description Schema

_links
optional

Links

absicherungen
optional

payment protection insurance

< Absicherung > array

bausparvertraege
optional

< Bausparvertrag > array

beleihungsRechnung
optional

mortgage value calculation

BeleihungsRechnung

bewertungDesAngebots
optional

type of advisory responsability

enum (ANGEBOT_ENTSPRICHT_DEM_WUNSCH_DES_KUNDEN, ANGEBOT_ENTSPRICHT_DER_EMPFEHLUNG_DES_KUNDENBETREUERS)

bonitaet
optional

creditworthiness

< Bonitaet > array

darlehen
optional

< Darlehen > array

erzeugtAm
optional

date offer created

string (date-time)

kennung
optional

additional offer name

string

machbarkeitsStatus
optional

feasibility state

enum (MACHBAR, NICHT_MACHBAR, UNTER_VORBEHALT_PRODUZENT)

meldungen
optional

< Meldung > array

pruefungsErgebnisse
optional

result of europace-offer-validation

< AngebotsPruefungsErgebnis > array

AngebotsPruefungsErgebnis

Name Schema

bewertung
optional

BewertungDurchProduktAnbieter

kfwKonditionsReservierung
optional

KfwKonditionsReservierung

produktAnbieterId
optional

string

AnnuitaetenDarlehen

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

bereitstellungsZins
optional

number

bereitstellungsZinsFreieZeitInMonaten
required

integer (int32)

laufzeitKalkulatorischInJahren
required

integer (int32)

sonderTilgungJaehrlich
required

number

tilgungsBeginnAm
optional

Example : "2020-03-28"

string (date-time)

zinsBindungInJahren
required

integer (int32)

Anschrift

Name Description Schema

hausnummer
optional

housenumber

string

ort
optional

place

string

plz
optional

zip-code

string

strasse
optional

street

string

Antraege

list of applications

Name Schema

_links
optional

PaginationLinks

antraege
optional

< Antrag > array

Antrag

application for a loan provider to approve

Name Description Schema

_links
optional

Links

angebot
optional

The offer on which the application is based on. Not returned in the list of all applications.

AngebotZumAntrag

ansprechpartner
optional

clerk. Not returned in the list of all applications.

Partner

antragsNummer
optional

application-id

string

antragsReferenz
optional

loan providers reference for application

string

beratung
optional

information about advisor type. Not returned in the list of all applications.

Beratung

datenKontext
optional

usage mode of the api for production or testmode

enum (ECHT_GESCHAEFT, TEST_MODUS)

dokumente
optional

all generated documents, shared proofs and documents uploaded by loan provider. Not returned in the list of all applications.

< Dokument > array

entscheidungsreifeVomVertriebSignalisiert
optional

advisor-mark of final state for approving

boolean

kreditSachbearbeiter
optional

loan officer. Not returned in the list of all applications.

Partner

letzteAenderung
optional

last changed date

string (date-time)

letztesEreignis
optional

last event date. For example for messages from the advisors.

string (date-time)

produktAnbieter
optional

Not returned in the list of all applications.

ProduktAnbieter

prolongation
optional

Not returned in the list of all applications.

boolean

status
optional

state of application. Not returned in the list of all applications.

AntragsStatus

vermittler
optional

advisor. Not returned in the list of all applications.

Partner

vertriebsStrukturZumZeitpunktDerAnnahme
optional

distribution channels of advisor and/or clerk at creation date of application. Not returned in the list of all applications.

VertriebsStruktur

voraussichtlicheBearbeitung
optional

estimated approval date. Not returned in the list of all applications.

string (date)

vorgangsReferenz
optional

advisors reference for case. Not returned in the list of all applications.

string

weitereAntragsReferenzen
optional

additional loan providers references. Will be visible to the advisor. Not returned in the list of all applications.

< string, string > map

zeitpunktDerAnnahme
optional

creation date of application

string (date-time)

zugrundeliegendeDaten
optional

data of applicants, property and project, wich is the source for application. Not returned in the list of all applications.

ZugrundeliegendeDatenZumAntrag

AntragsStatus

application state

Name Description Schema

antragsteller
optional

application state advisor-side

enum (BEANTRAGT, NICHT_ANGENOMMEN, UNTERSCHRIEBEN, WIDERRUFEN)

antragstellerAblehnungsgrund
optional

reason for rejection by customer

enum (ANDERER_GRUND, ANDERES_ANGEBOT_ANGENOMMEN, ANGEBOT_WETTBEWERBER, BEARBEITUNGSZEIT, FINANZIERUNG_WIRD_ANGEPASST, KONDITIONEN_UNPASSEND, KUNDE_NICHT_ERREICHBAR, OBJEKT_NICHT_INTERESSANT, OBJEKT_NICHT_VERFUEGBAR)

bearbeitungsFortschritt
optional

application phase

enum (FREIGEGEBEN_FUER_SAMMELFORDERUNG, NICHT_VON_PRODUKTANBIETER_BESTAETIGT, PROVISION_IN_BEARBEITUNG, PROVISON_AN_KUNDENBETREUER_VOLLSTAENDIG_AUSGEZAHLT, VON_PRODUKTANBIETER_BESTAETIGT)

produktAnbieter
optional

application state loan provider-side

enum (ABGELEHNT, NICHT_BEARBEITET, UNTERSCHRIEBEN, ZURUECKGESTELLT)

produktanbieterAblehnungsgrund
optional

reason for rejection by loan provider

enum (FINANZIELLE_SITUATION, GEGENANGEBOT, KEINE_ANGABE, KRITERIEN, NEGATIV_MERKMAL, UNTERLAGEN_UNVOLLSTAENDIG, WERTERMITTLUNG)

Antragsteller

customer

Name Description Schema

absicherungsAngaben
optional

AbsicherungsAngaben

anrede
optional

enum (FRAU, HERR)

anschrift
optional

Postadresse

arbeitserlaubnis
optional

only with non-EU nationality

boolean

arbeitserlaubnisBefristetBis
optional

only with restricted work permit

string (date)

aufenthaltsTitel
optional

only with non-EU nationality

enum (AUFENTHALTS_ERLAUBNIS, BLAUE_KARTE_EU, DAUERAUFENTHALT_EU, NIEDERLASSUNGS_ERLAUBNIS, VISUM)

aufenthaltsTitelBefristetBis
optional

date of restricted residence permisson

string (date)

berufsgruppeBeiIngDiba
optional

professional group (ING) loan provider specific data (optional). allowed values: ANGESTELLTER, ARBEITER, BEAMTER, FREIBERUFLER, SELBSTSTAENDIG, RENTNER, HAUSMANN, PRIVATIER, SOLDAT, SCHUELER, AZUBI, STUDENT, OHNE. (More value can be attached)

string

beschaeftigung
optional

Beschaeftigung

beschaeftigungImOeffentlichenDienstBeiDsl
optional

boolean

branche
optional

sector, loan provider specific data (optional)(More value can be attached)

< Branche > array

brancheBeiIngDiba
optional

Deprecated. Pls use property 'branche'. sector (ING) loan provider specific data (optional). allowed values: BANKEN_VERSICHERUNGEN, BAUGEWERBE, DIENSTLEISTUNGEN_SONSTIGE, EDV_BERATUNG, ENERGIE, ERZIEHUNG_UNTERRICHT, GESUNDHEITSWESEN, HANDEL, HANDWERK, HOTEL_GASTRONOMIE, LANDWIRTSCHAFT, OEFFENTLICHER_DIENST, PRODUKTION_INDUSTRIE, VERKEHR.(More value can be attached)

string

brancheBeiMhb
optional

Deprecated. Pls use property 'branche'. sector (MHB) loan provider specific data (optional). allowed values: VERARBEITENDES_GEWERBE, BAU, HANDEL, VERKEHR_INFORMATION, DIENSTLEISTUNG, SONSTIGES.(More value can be attached)

string

brancheBeiSRating
optional

Deprecated. Pls use property 'branche'. sector (Sparkassen) loan provider specific data (optional). allowed values: BAUGEWERBE, DIENSTLEISTUNGEN, ENERGIE_UND_WASSERVERSORGUNG_BERGBAU, GEBIETSKOERPERSCHAFTEN_UND_SOZIALVERSICHERUNGEN, GESUNDHEITSWESEN, HANDEL, HOTEL_UND_GASTRONOMIE, KREDITINSTITUTE, LAND_UND_FORSTWIRTSCHAFT_FISCHEREI, OEFFENTLICHER_DIENST, ORGANISATIONEN_OHNE_ERWERBSZWECK_PRIVATE_HAUSHALTE, VERARBEITENDES_GEWERBE, VERKEHR_UND_NACHRICHTENUEBERMITTLUNG, VERSICHERUNGEN, SONSTIGE.(More value can be attached)

string

bruttoJahresEinkommenErwartet
optional

number

bruttoVorjahresEinkommen
optional

number

email
optional

string

externeAntragstellerId
optional

string

familienstand
optional

enum (GESCHIEDEN, GETRENNT_LEBEND, LEBENSPARTNERSCHAFT, LEDIG, VERHEIRATET, VERWITWET)

geburtsdatum
optional

string (date)

geburtsort
optional

place of birthloan provider specific data (optional) relevant for building society safe loans

string

guetertrennungVereinbartWennVerheiratet
optional

only if married

boolean

id
optional

string

inDeutschlandSeit
optional

only with non-EU nationality

string (date)

legitimationsDaten
optional

loan provider specific data (optional)

LegitimationsDaten

nachname
optional

string

schufaErgebnis
optional

SchufaErgebnis

sozialversicherungsnummer
optional

string

staatsangehoerigkeit
optional

Staat

steuerId
optional

string

telefonnummer
optional

string

telefonnummerVorwahl
optional

string

titelDoktor
optional

boolean

titelProfessor
optional

boolean

verheiratetMitAntragsteller
optional

Deprecated. only if married

AntragstellerVerknuepfung

vorAnschrift
optional

Postadresse

vorname
optional

string

weitereKontaktMoeglichkeiten
optional

string

wohnhaftSeit
optional

string (date)

AntragstellerVerknuepfung

Name Description Schema

id
optional

string

name
optional

only for better readability, pls use antragsteller-ressource

string

AusgabenMonatlich

Name Description Schema

ausgabenMonatlich
optional

number

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

Autostellplatz

Name Schema

mieteinnahmenMonatlich
optional

number

typ
optional

enum (CARPORT, DOPPEL_GARAGE, GARAGE, KELLER_GARAGE, STELLPLATZ, TIEFGARAGEN_STELLPLATZ)

BankUndSparguthaben

Name Description Schema

aktuellerWert
optional

number

maximalAufzuloesenderWert
optional

number

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

zinsertragJaehrlich
optional

number

Bankverbindung

bank account

Name Schema

bic
optional

string

iban
optional

string

id
optional

string

kontoinhaberIds
optional

< string > array

kontoinhaberName
optional

string

kreditinstitut
optional

string

BausparAngebot

Name Description Schema

abschlussGebuehr
optional

number

abschlussGebuehrenVerrechnung
optional

allowed values: SOFORTZAHLUNG, VERRECHNUNG

enum (SOFORTZAHLUNG, VERRECHNUNG)

angebotsHinweisFuerAntragsteller
optional

only with external building society saving loans an counteroffers

string

bausparSumme
optional

number

einmalzahlung
optional

Deprecated. Einmalzahlungen are part of Sonderzahlungen.

number

gesamtLaufzeitInJahren
optional

only with external building society saving loans

integer (int32)

id
optional

string

produktAnbieter
optional

ProduktAnbieter

sonderZahlungen
optional

< SonderZahlung > array

sparBeginn
optional

string (date)

sparPhase
optional

SparPhase

tarif
optional

name of tariff

string

tilgungsPhase
optional

TilgungsPhase

typ
optional

string

vertragsBeginn
optional

contract start

string (date)

vertragsNummer
optional

contract number

string

vertragsPartner
optional

only with external building society saving loans

< AntragstellerVerknuepfung > array

verwaltungsgebuehrenJaehrlich
optional

number

zuteilungsDatum
optional

string (date)

Bausparvertrag

building society savings contract details

Name Description Schema

abschlussGebuehr
optional

number

abschlussGebuehrenVerrechnung
optional

allowed values: SOFORTZAHLUNG, VERRECHNUNG

enum (SOFORTZAHLUNG, VERRECHNUNG)

angebotsHinweisFuerAntragsteller
optional

only with external building society saving loans an counteroffers

string

bausparSumme
optional

number

einmalzahlung
optional

Deprecated. Einmalzahlungen are part of Sonderzahlungen.

number

gesamtLaufzeitInJahren
optional

only with external building society saving loans

integer (int32)

id
optional

string

produktAnbieter
optional

ProduktAnbieter

sonderZahlungen
optional

< SonderZahlung > array

sparBeginn
optional

string (date)

sparPhase
optional

SparPhase

tarif
optional

name of tariff

string

tarifId
optional

loan provider Tarif-ID of building society saving loan tariff

string

tilgungsPhase
optional

TilgungsPhase

typ
optional

string

vertragsBeginn
optional

contract start

string (date)

vertragsNummer
optional

contract number

string

vertragsPartner
optional

list of applicants

< AntragstellerVerknuepfung > array

verwaltungsgebuehrenJaehrlich
optional

number

zuteilungsDatum
optional

string (date)

BeleihungsRechnung

Name Description Schema

beleihungsAuslauf
optional

loan to value ratio

number

beleihungsWerte
optional

list of mortgage values

< BeleihungsWert > array

beleihungsWerteSumme
optional

sum of mortgage values

number

objektbewertungen
optional

list of property valuations

< Objektbewertung > array

produktAnbieter
optional

ProduktAnbieter

BeleihungsWert

Name Description Schema

adresse
optional

adress of property

Postadresse

beleihungsWert
optional

mortgage value

number

immobilie
optional

property

ImmobilieVerknuepfung

Beratung

Name Description Schema

art
optional

advisory type

enum (AUSSER_GESCHAEFTSRAUM_VERTRAG, FERN_ABSATZ_GESCHAEFT, PRAESENZ_GESCHAEFT)

hinweisFuerProduktAnbieter
optional

advisors message for loan officer

string

istKundenBetreuerVerkaeuferOderMaklerDerImmobilie
optional

true, if advisor is estate agent in this case too

boolean

Bereitstellung

Name Description Schema

bereitstellungsZins
optional

commitment interest

number

bereitstellungsZinsFreieZeitInMonaten
optional

time of no commitment interest in month

integer (int32)

Beschaeftigung

profession

Name Description Schema

anzahlGehaelterProJahr
optional

only with art==ANGESTELLTER,ARBEITER,BEAMTER

number (double)

arbeitgeber
optional

only with art==ANGESTELLTER,ARBEITER,BEAMTER

string

arbeitgeberInDeutschlandAnsaessig
optional

only with art==ANGESTELLTER,ARBEITER,BEAMTER

boolean

art
optional

allowed values:ANGESTELLTER, ARBEITER, ARBEITSLOSER, BEAMTER, FREIBERUFLER, HAUSFRAU, RENTNER, SELBSTAENDIGER

string

befristungsStatus
optional

only with art==ANGESTELLTER,ARBEITER

enum (BEFRISTET, UNBEFRISTET)

beruf
optional

only with art!=RENTNER

string

beschaeftigtSeit
optional

only with art==ANGESTELLTER,ARBEITER,BEAMTER,FREIBERUFLER,SELBSTAENDIGER

string (date)

einkommenNettoJaehrlich
optional

only with art==FREIBERUFLER,SELBSTAENDIGER

number

einkommenNettoMonatlich
optional

only with art==ANGESTELLTER,ARBEITER,BEAMTER

number

inProbezeit
optional

only with art==ANGESTELLTER,ARBEITER,BEAMTER

boolean

situationNachRenteneintritt
optional

only with art!=RENTNER

SituationNachRenteneintritt

sonstigesRegelmaessigesEinkommenNettoMonatlich
optional

only with art==ARBEITSLOSER,HAUSFRAU

number

staatlicheRenteNettoMonatlich
optional

only with art==RENTNER

number

taetigkeit
optional

only with art==FREIBERUFLER,SELBSTAENDIGER. allowed values: ALTENPFLEGER, AMBULANTER_KRANKENPFLEGER, ANWALT, APOTHEKER, ARCHITEKT, ARZT, BESTATTER, DATENSCHUTZBEAUFTRAGTER, DEKORATEUR, DIAETASSISTENT, DOLMETSCHER, EDV_BERATER, ERGOTHERAPEUT, ERNAEHRUNGSBERATER, FOTOGRAF, GEOGRAF, GRAFIKDESIGNER, GRAFIKER, HEBAMME, HEILMASSEUR, HEILPRAKTIKER, HISTORIKER, INFORMATIKER, INGENIEUR, INSOLVENZVERWALTER, JOURNALIST, KLASSISCHER_KONZERTMUSIKER, KONSTRUKTEUR, KRANKENGYMNAST, KRANKENPFLEGER, KRANKENSCHWESTER, LOGOPAEDE, MEDIZINISCH_TECHN_ASSISTENT, NOTAR, OPERNSAENGER, PERSONALBERATER, PHYSIOTHERAPEUT, PSYCHOLOGE, RAUMAUSSTATTER, RUNDFUNKSPRECHER, SACHVERSTAENDIGER, STADTPLANER, STATIKER, STEUERBERATER, TIERARZT, UNTERNEHMENSBERATER, VERMITTLER, WIRTSCH_BUCHPRUEFER_REVISOR, ZAHNARZT, ZAHNTECHNIKER, SONSTIGES.

string

BestehendeImmobilie

existing property

Name Description Schema

adresse
optional

Postadresse

autostellplaetze
optional

< Autostellplatz > array

bestehendeDarlehen
optional

< BestehendesDarlehen > array

bodenRichtwert
optional

loan provider specific data (optional)

number

erbbaurecht
optional

Erbbaurecht

gebaeude
optional

Gebaeude

grundbuchAngabe
optional

GrundbuchAngabe

grundstueck
optional

Grundstueck

id
optional

string

immobilienEinsatz
optional

enum (ALS_ZUSATZSICHERHEIT, KEIN_EINSATZ, VERKAUFEN)

keinBaulandFlaecheInQm
optional

loan provider specific data (optional)

number

marktueblicherKaufpreisProQm
optional

loan provider specific data (optional)

number

maximalEinzusetzenderBetragWennVerkauf
optional

number

objektArt
optional

enum (EIGENTUMSWOHNUNG, GRUNDSTUECK, HAUS)

vergleichsmieteFuerGewerbeflaecheProQm
optional

loan provider specific data (optional)

number

vergleichsmieteFuerWohnflaecheProQm
optional

loan provider specific data (optional)

number

verkehrswert
optional

number

vorlaeufigerVerkehrswert
optional

loan provider specific data (optional)

number

wohnlage
optional

loan provider specific data (optional). allowed values: GEHOBEN,MITTEL,EINFACH. (More values can be attached)

string

BestehenderBausparvertrag

Name Description Schema

abschlussGebuehr
optional

number

aktuellerWert
optional

number

bausparSumme
optional

number

einmalzahlung
optional

Deprecated. Einmalzahlungen are part of Sonderzahlungen.

number

id
optional

string

maximalAufzuloesenderBetrag
optional

number

produktAnbieter
optional

ProduktAnbieter

sonderZahlungen
optional

< SonderZahlung > array

sparBeitragMonatlich
optional

number

tarif
optional

name of tariff

string

typ
optional

string

vermoegensEinsatz
optional

enum (ABTRETEN, AUFLOESEN, KEIN_EINSATZ)

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

vertragsBeginn
optional

contract start

string (date)

vertragsNummer
optional

contract number

string

verwaltungsgebuehrenJaehrlich
optional

number

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

zuteilungsDatum
optional

string (date)

BestehendesDarlehen

Name Description Schema

abzuloesendeRestschuld
optional

Deprecated.

number

aktuelleRestschuldWennNichtAbzuloesen
optional

Deprecated. only with wirdAbgeloest==true

number

bausteinId
optional

string

darlehensArt
optional

allowed values: BAUSPARDARLEHEN,FOERDERDARLEHEN,IMMOBILIENDARLEHEN,PRIVATDARLEHEN,SONSTIGES_DARLEHEN (More values can be attached)

enum (BAUSPARDARLEHEN, FOERDERDARLEHEN, IMMOBILIENDARLEHEN, PRIVATDARLEHEN, SONSTIGES_DARLEHEN)

darlehensBetrag
optional

loan amount, only with verwendungszweck==ANSCHLUSSFINANZIERUNG

number

darlehensGeber
optional

ProduktAnbieter

darlehensKontonummer
optional

account number of prolongation, only with verwendungszweck==ANSCHLUSSFINANZIERUNG

string

eingetrageneGrundschuld
optional

number

grundschuldArt
optional

allowed values: BUCH_GRUNDSCHULD, BRIEF_GRUNDSCHULD (More values can be attached)

enum (BRIEF_GRUNDSCHULD, BUCH_GRUNDSCHULD)

hauptKontonummerDslBank
optional

DSL account number, only with loan provider='DSL Bank' and verwendungszweck==ANSCHLUSSFINANZIERUNG

string

id
optional

string

laufzeitEnde
optional

string (date)

rateMonatlich
optional

number

restschuldAktuell
optional

remainder of debt

number

restschuldZumAbloeseTermin
optional

calculated remainder of debt at end of the fixed interest period

number

sollZins
optional

number

sondertilgungZumZinsBindungsEnde
optional

amount of special redemption at the end of fixed interest period, only with verwendungszweck==ANSCHLUSSFINANZIERUNG

number

wirdAbgeloest
optional

TRUE if loan will be replaced

boolean

zinsBindungEndetAm
optional

string (date)

BestehendesDarlehenDesFinanzierungsObjekts

Name Description Schema

abzuloesendeRestschuld
optional

Deprecated.

number

aktuelleRestschuldWennNichtAbzuloesen
optional

Deprecated. only with wirdAbgeloest==true

number

bausteinId
optional

string

darlehensArt
optional

allowed values: BAUSPARDARLEHEN,FOERDERDARLEHEN,IMMOBILIENDARLEHEN,PRIVATDARLEHEN,SONSTIGES_DARLEHEN (More values can be attached)

enum (BAUSPARDARLEHEN, FOERDERDARLEHEN, IMMOBILIENDARLEHEN, PRIVATDARLEHEN, SONSTIGES_DARLEHEN)

darlehensBetrag
optional

loan amount, only with verwendungszweck==ANSCHLUSSFINANZIERUNG

number

darlehensGeber
optional

ProduktAnbieter

darlehensKontonummer
optional

account number of prolongation, only with verwendungszweck==ANSCHLUSSFINANZIERUNG

string

eingetrageneGrundschuld
optional

number

grundschuldArt
optional

allowed values: BUCH_GRUNDSCHULD, BRIEF_GRUNDSCHULD (More values can be attached)

enum (BRIEF_GRUNDSCHULD, BUCH_GRUNDSCHULD)

hauptKontonummerDslBank
optional

DSL account number, only with loan provider='DSL Bank' and verwendungszweck==ANSCHLUSSFINANZIERUNG

string

id
optional

string

laufzeitEnde
optional

string (date)

rateMonatlich
optional

number

restschuldAktuell
optional

remainder of debt

number

restschuldZumAbloeseTermin
optional

calculated remainder of debt at end of the fixed interest period

number

sollZins
optional

number

sondertilgungZumZinsBindungsEnde
optional

amount of special redemption at the end of fixed interest period, only with verwendungszweck==ANSCHLUSSFINANZIERUNG

number

verwendenAls
optional

enum (ABLOESEN, TRITT_IM_RANG_ZURUECK, TRITT_NICHT_IM_RANG_ZURUECK)

wirdAbgeloest
optional

TRUE if loan will be replaced

boolean

zinsBindungEndetAm
optional

string (date)

BewertungDurchProduktAnbieter

Name Description Schema

id
optional

only produktAnbieterId==DEUTSCHE_BANK

string

Bonitaet

creditworthiness

Name Description Schema

angerechneteLebensHaltungsKosten
optional

included living costs

number

angerechneteRatenAllerFinanzierungsDarlehen
optional

new loan rates

number

bewirtschaftungsKostenAllerFremdgenutzerFlaechen
optional

operating costs for all external-used properties (rent)

number

haushaltsUeberschuss
optional

budget surplus

number

kreditEntscheider
optional

loan officer

ProduktAnbieter

nebenkostenAllerEigengenutzterWohnflaechen
optional

ancillary costs for all own-used properties

number

produktAnbieter
optional

loan provider

ProduktAnbieter

Branche

sector

Name Description Schema

typ
optional

enum (ING, MHB, S_RATING)

wert
optional

diffrent values depended on type:

sector ING allowed values: BANKEN_VERSICHERUNGEN, BAUGEWERBE, DIENSTLEISTUNGEN_SONSTIGE, EDV_BERATUNG, ENERGIE, ERZIEHUNG_UNTERRICHT, GESUNDHEITSWESEN, HANDEL, HANDWERK, HOTEL_GASTRONOMIE, LANDWIRTSCHAFT, OEFFENTLICHER_DIENST, PRODUKTION_INDUSTRIE, VERKEHR

sector MHB allowed values: VERARBEITENDES_GEWERBE, BAU, HANDEL, VERKEHR_INFORMATION, DIENSTLEISTUNG, SONSTIGES

sector S_RATING allowed values: BAUGEWERBE, DIENSTLEISTUNGEN, ENERGIE_UND_WASSERVERSORGUNG_BERGBAU, GEBIETSKOERPERSCHAFTEN_UND_SOZIALVERSICHERUNGEN, GESUNDHEITSWESEN, HANDEL, HOTEL_UND_GASTRONOMIE, KREDITINSTITUTE, LAND_UND_FORSTWIRTSCHAFT_FISCHEREI, OEFFENTLICHER_DIENST, ORGANISATIONEN_OHNE_ERWERBSZWECK_PRIVATE_HAUSHALTE, VERARBEITENDES_GEWERBE, VERKEHR_UND_NACHRICHTENUEBERMITTLUNG, VERSICHERUNGEN, SONSTIGE

string

Darlehen

loan details

Name Description Schema

auszahlungsBetrag
optional

disbursement amount
Example : 365000.0

number

auszahlungsDatum
optional

disbursement date

string (date)

auszahlungsKurs
optional

disbursement ratio
Example : 100.0

number

bausparSumme
optional

building savings amount, only with darlehensTyp==BAUSPAR_DARLEHEN

number

bausparTarif
optional

building savings tariff, only with darlehensTyp==BAUSPAR_DARLEHEN

string

bausteinId
optional

string

bereitstellung
optional

not with darlehensTyp==PRIVAT_DARLEHEN

Bereitstellung

darlehensBetrag
optional

loan amount
Example : 365000.0

number

darlehensTyp
optional

enum (ANNUITAETEN_DARLEHEN, BAUSPAR_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

detailsZurVerwendung
optional

only with darlehensTyp==ZWISCHEN_FINANZIERUNG

string

effektivZins
optional

actual interest
Example : 2.35

number

effektivZinsRelevanteKosten
optional

costs for calculation of actual interest

EffektivZinsKosten

einstandsDatum
optional

debit interest date

string (date-time)

forwardPeriodeInMonaten
optional

forward period in month, only with darlehensTyp==FORWARD_DARLEHEN

integer (int32)

kalkulatorischesLaufzeitEnde
optional

calculated end of redemption period, not with darlehensTyp==ZWISCHEN_FINANZIERUNG

string (date)

kfwEnergieEffizienzGruppe
optional

KfW-energy-reference-groups, only with darlehensTyp==KFW_DARLEHEN. (allowed values: STANDARD, NEUBAU, SANIERUNG)Only relevant with KfW-Programm 153, 261, 262. If new energy-reference-groups will follow, more values can be attached.)

string

kfwEnergieEffizienzStandard
optional

KfW-energy-standards, only with darlehensTyp==KFW_DARLEHEN (allowed values: STANDARD_40, STANDARD_40_PLUS, STANDARD_40_EEK, STANDARD_40_NH, STANDARD_55, STANDARD_55_EEK, STANDARD_70, STANDARD_70_EEK, STANDARD_85, STANDARD_85_EEK, STANDARD_100, STANDARD_100_EEK, STANDARD_DENKMAL, STANDARD_DENKMAL_EEK, KLIMAFREUNDLICH_STANDARD, KLIMAFREUNDLICH_QNG) Only relevant with KfW-Programm 153, 261, 262. If new KfW-energy-standards will follow, more values can be attached.

string

kfwProgramm
optional

KfW-program, only with darlehensTyp==KFW_DARLEHEN (allowed values: PROGRAMM_124, PROGRAMM_151, PROGRAMM_152, PROGRAMM_153, PROGRAMM_159, PROGRAMM_167, PROGRAMM_261, PROGRAMM_262, PROGRAMM_297, PROGRAMM_298, PROGRAMM_300, PROGRAMM_308, PROGRAMM_358, PROGRAMM_359) If new KfW programs will follow, more values can be attached.

string

kfwSanierungsFahrplanLiegtVor
optional

plan of refurbishment exists, with darlehensTyp==KFW_DARLEHEN and program 261, 262

boolean

konditionWurdeManuellAngepasst
optional

true, if advisor overrides the interest rate

boolean

konditionsAnpassungsBegruendung
optional

reason for overriding interest rate

string

konditionsAnpassungsDelta
optional

delta in percent-point of overriding (eg overrided 1,25% - calculated 1,50% = delta -0,25%).
Example : -0.25

number

laufZeitInJahren
optional

only with darlehensTyp==KFW_DARLEHEN or darlehensTyp==REGIONAL_FOERDER_DARLEHEN

integer (int32)

laufzeitInMonaten
optional

redemption period in month, only with darlehensTyp==PRIVAT_DARLEHEN

integer (int32)

maximaleLaufzeitInMonaten
optional

only with darlehensTyp==ZWISCHEN_FINANZIERUNG

integer (int32)

produktAnbieter
optional

loan provider

ProduktAnbieter

produktAnbieterSpezifischeDarlehensMerkmale
optional

Additional lender-specific data. Only populated in specific use cases when you sell your own credit products.

< string, object > map

produktFeatures
optional

list of features specific to the credit product

< enum (KONTO_CHECK, ONE_CLICK) > array

produktId
optional

lender-specific identifier of the credit product

string

provision
optional

commission

Provision

rateMonatlich
optional

rate for redemption
Example : 723.34

number

rateMonatlichInDerTilgungsfreienAnlaufzeit
optional

rate in the beginning years of no redemption, only with darlehensTyp==KFW_DARLEHEN or darlehensTyp==REGIONAL_FOERDER_DARLEHEN

number

regionalFoerderbankProgramm
optional

regional support program, only with darlehensTyp==REGIONAL_FOERDER_DARLEHEN (allowed values: L_BANK_KOMBI_DARLEHEN_WOHNEN, L_BANK_WOHNEN_MIT_KIND, NRW_BANK_WOHNEIGENTUM, NRW_BANK_GEBAEUDESANIERUNG, NRW_BANK_NACHHALTIG_WOHNEN. If new program will follow, more values can be attached.)

string

sollZins
optional

debit interest
Example : 2.05

number

tilgung
optional

not with darlehensTyp==ZWISCHEN_FINANZIERUNG

Tilgung

tilgungsFreieAnlaufJahre
optional

beginning years of no redemption, only with darlehensTyp==KFW_DARLEHEN or darlehensTyp==REGIONAL_FOERDER_DARLEHEN

integer (int32)

vertragsPartner
optional

only with external building society saving loans

< AntragstellerVerknuepfung > array

verwendungsZweck
optional

only with darlehensTyp==ZWISCHEN_FINANZIERUNG

enum (SONSTIGE_VERWENDUNG, VERKAUF_EINES_ANDEREN_OBJEKTS, VORFINANZIERUNG_OEFFENTLICHER_MITTEL)

zinsBindung
optional

not with darlehensTyp IN [VARIABLES_DARLEHEN,ZWISCHEN_FINANZIERUNG]

ZinsBindung

zinsZahlungsBeginnAm
optional

start of payment of interest (begins with loan disbursement or reaching the end time of no commitment interest)

string (date)

Dokument

Name Description Schema

art
optional

partly not available

string

href
optional

string

name
optional

source filename with extension

string

titel
optional

document name

string

type
optional

mediatype of document, see <a href="http://tools.ietf.org/html/rfc7231#section-3.1.1.1">HTTP 1.1: Semantics and Content, section 3.1.1.1</a>

string

EffektivZinsKosten

Name Schema

beratungsHonorar
optional

number

grundbuchKosten
optional

number

laufendeVerwaltungskostenJaehrlich
optional

number

sonstigeKosten
optional

number

tilgungsErsatzProduktKosten
optional

number

wohnGebaeudeVersicherungsKosten
optional

number

zinsabsicherungsKosten
optional

number

zusatzSicherheitsKosten
optional

number

EinkuenfteAusNebentaetigkeit

Name Description Schema

beginnDerNebentaetigkeit
optional

string (date)

einnahmenMonatlich
optional

number

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

EinnahmenMonatlich

Name Description Schema

einnahmenMonatlich
optional

number

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

Eintrag

Name Schema

abgeltungssteuer
optional

number

datum
optional

string (date)

kontofuehrungsGebuehr
optional

number

laufendeGebuehr
optional

number

riesterZulage
optional

number

saldo
optional

number

tilgung
optional

number

typ
optional

enum (AGGREGIERTER_EINTRAG, EINTRAG, SUMMEN_EINTRAG_ZUM_ZINSBINDUNGSENDE)

zahlung
optional

number

zahlungsTyp
optional

enum (AUSZAHLUNG, EINZAHLUNG)

zinsen
optional

number

EndEnergie

Name Description Schema

aktuell
optional

current energy consumption

number (double)

geplant
optional

planned energy consumption

number (double)

EnergieEffizienzAusweis

Name Schema

ausweisTyp
optional

enum (ENDENERGIEBEDARF, ENDENERGIEVERBRAUCH)

endEnergie
optional

EndEnergie

primaerEnergieTyp
optional

enum (ABFAELLE, BRAUNKOHLE, HOLZ, NETZSTROM, OEL_GAS, PHOTOVOLTAIK_WINDKRAFT, SONSTIGES, STEINKOHLE, VERDRAENGUNGSSTROM, WAERME_KAELTE)

Erbbaurecht

Name Description Schema

erbbauzinsJaehrlich
optional

number

grundstuecksEigentuemer
optional

enum (ANDERE, OEFFENTLICH_KIRCHLICH)

laufzeitBisJahr
optional

4-digit year
Example : "2022"

string

Error

Name Schema

message
optional

string

statusCode
optional

integer (int32)

statusMessage
optional

string

traceId
optional

string

Finanzbedarf

Name Description Schema

anzahlTeilzahlungen
optional

Number of payouts for purchase from a property developer or a renovation

integer (int32)

aussenAnlagen
optional

costs for gardening

number

bauNebenkosten
optional

additional costs for construction (eg connection to power-net, telecommunication and waste water)

number

bereitsBeglichen
optional

costs already paid

number

erschliessung
optional

costs for development

number

grunderwerbsteuer
optional

real property acquisition tax, ancillary costs

number

grundstueckBereitsBezahlt
optional

'true' → land already paid, 'false' - land not yet paid, 'null' if not 'Neubau'

boolean

grundstuecksKaufpreis
optional

purchasing costs for land

number

herstellung
optional

construction costs, including personal contribution

number

kapitalBeschaffung
optional

capital procurement from existing properties

number

kaufpreis
optional

purchasing price

number

maklergebuehr
optional

estate agents commission, ancillary costs

number

mobiliar
optional

furniture costs

number

modernisierung
optional

refurbishment costs, including personal contribution

number

notargebuehr
optional

notary fee, ancillary costs

number

renovierung
optional

renovation costs, including personal contribution

number

sonstigeKosten
optional

other costs

number

zusaetzlichesKapital
optional

additional capital

number

FinanzierungsObjekt

Name Description Schema

adresse
optional

Postadresse

autostellplaetze
optional

< Autostellplatz > array

bestehendeDarlehen
optional

< BestehendesDarlehenDesFinanzierungsObjekts > array

bodenRichtwert
optional

loan provider specific data (optional)

number

erbbaurecht
optional

Erbbaurecht

gebaeude
optional

Gebaeude

grundbuchAngabe
optional

GrundbuchAngabe

grundstueck
optional

Grundstueck

id
optional

string

keinBaulandFlaecheInQm
optional

loan provider specific data (optional)

number

marktueblicherKaufpreisProQm
optional

loan provider specific data (optional)

number

objektArt
optional

enum (EIGENTUMSWOHNUNG, GRUNDSTUECK, HAUS)

vergleichsmieteFuerGewerbeflaecheProQm
optional

loan provider specific data (optional)

number

vergleichsmieteFuerWohnflaecheProQm
optional

loan provider specific data (optional)

number

verkehrswert
optional

only relevant for AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung

number

vorlaeufigerVerkehrswert
optional

loan provider specific data (optional)

number

wohnlage
optional

loan provider specific data (optional). allowed values: GEHOBEN,MITTEL,EINFACH. (More values can be attached)

string

Flurstueck

Name Description Schema

anteil
optional

owning part

MiteigentumsAnteil

flur
optional

plot area

string

flurstuecksNummer
optional

plot number

string

groesse
optional

area dimension in square meter

number

ForwardDarlehen

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

bereitstellungsZins
optional

number

bereitstellungsZinsFreieZeitInMonaten
required

integer (int32)

forwardPeriodeInMonaten
required

integer (int32)

laufzeitKalkulatorischInJahren
required

integer (int32)

sonderTilgungJaehrlich
required

number

tilgungsBeginnAm
optional

Example : "2020-03-28"

string (date-time)

zinsBindungInJahren
required

integer (int32)

Gebaeude

Name Description Schema

anzahlDerGewerbeeinheiten
optional

only with ObjektArt == HAUS.

integer (int32)

anzahlDerWohneinheitenImGebaeude
optional

integer (int32)

anzahlVollgeschosse
optional

integer (int32)

ausstattung
optional

equipment of property for the automatic mortage evaluation (VDP), not ING, allowed values: EINFACH,MITTEL,GEHOBEN,STARK_GEHOBEN (More values can be attached)

string

baujahr
optional

construction year of property. Only with verwendungsZweck != NEUBAU4-digit year
Example : "2022"

string

bauweise
optional

allowed values: FACHWERK_MIT_STROH_LEHM,FACHWERK_MIT_ZIEGELN,GLAS_STAHL,HOLZ,MASSIV (More values can be attached)

string

bezeichnungWohneinheit
optional

only with ObjektArt == EIGENTUMSWOHNUNG.

string

dachgeschossAusbau
optional

only with ObjektArt == HAUS. allowed values: FLACHDACH,NICHT_AUSGEBAUT,TEILWEISE_AUSGEBAUT,VOLL_AUSGEBAUT (More values can be attached)

string

einliegerwohnungVorhanden
optional

only with ObjektArt == HAUS.

boolean

energieEffizienzAusweis
optional

EnergieEffizienzAusweis

gewerbeflaeche
optional

GebaeudeFlaeche

hausAnordnung
optional

enum (FREISTEHEND, KOPFHAUS, MITTELHAUS)

hausTyp
optional

only with ObjektArt == HAUS.

enum (DOPPELHAUSHAELFTE, EINFAMILIENHAUS, MEHRFAMILIENHAUS, REIHENHAUS, ZWEIFAMILIENHAUS)

istFertighaus
optional

only with ObjektArt == HAUS.

boolean

kubatur
optional

Angabe in Kubikmetern. loan provider specific data (optional)

number

miteigentumsAnteil
optional

only with ObjektArt == EIGENTUMSWOHNUNG.

MiteigentumsAnteil

modernisierungen
optional

loan provider specific data (optional)

< Modernisierung > array

modernisierungsAngaben
optional

Deprecated. Pls use list of refurbishment.

ModernisierungsAngaben

unterkellerung
optional

only with ObjektArt == HAUS. allowed values: NICHT_UNTERKELLERT,TEILWEISE_UNTERKELLERT,UNTERKELLERT (More values can be attached)

string

wohnflaeche
optional

GebaeudeFlaeche

zustand
optional

condition of the property for the automatic mortage evaluation (VDP)

enum (GUT, MAESSIG, MITTEL, SCHLECHT, SEHR_GUT)

GebaeudeFlaeche

Name Schema

gesamtGroesse
optional

number

vermietungsInformationen
optional

VermietungsInformationen

Gegenangebot

Name Description Schema

darlehen
required

< GegenangebotDarlehen > array

kennung
optional

name of offer, visible in advisors offerlist, eg. 'Sonderangebot'

string

GegenangebotDarlehen

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

GrundbuchAngabe

Name Description Schema

amtsgericht
optional

competent local court

string

anmerkungen
optional

comment

string

bandUndBlatt
optional

book and page

string

flurstuecke
optional

plot of land

< Flurstueck > array

ort
optional

place of the local court responsible as the land registry office

string

rechteInAbteilung2
optional

Encumbrances and restrictions on the usability of the property. Pipeline rights, waivers of distance areas, rights of way, insolvency notices.

RechteAbteilung2

Grundstueck

plot

Name Description Schema

groesse
optional

plot dimensions in square meter

number

grundstuecksArt
optional

type of plot

enum (LANDWIRTSCHAFTLICHES_GRUNDSTUECK, SONSTIGES_GRUNDSTUECK, UNBEBAUTES_GEWERBEGRUNDSTUECK, UNBEBAUTES_MISCHGRUNDSTUECK, UNBEBAUTES_WOHNGRUNDSTUECK)

Haushalt

household

Name Description Schema

antragsteller
optional

< Antragsteller > array

anzahlErwachseneImHaushalt
optional

loan provider specific data (optional)

integer (int32)

anzahlKinderNichtImHaushalt
optional

loan provider specific data (optional)

integer (int32)

bestehendeImmobilien
optional

< BestehendeImmobilie > array

erfahrungImmobilienFinanzierung
optional

customer has financed before

boolean

id
optional

string

kfzAnzahl
optional

loan provider specific data (optional)

integer (int32)

kinder
optional

< Kind > array

lebenshaltungsKostenMonatlich
optional

loan provider specific data (optional) (DSL Bank)

number

obligo
optional

VermoegenVerbindlichkeiten

positionen
optional

HaushaltsPositionen

HaushaltsPositionen

Name Description Schema

bankUndSparguthaben
optional

< BankUndSparguthaben > array

bausparvertraege
optional

< BestehenderBausparvertrag > array

ehegattenUnterhalt
optional

< EinnahmenMonatlich > array

einkuenfteAusNebentaetigkeit
optional

< EinkuenfteAusNebentaetigkeit > array

kindergeld
optional

read-only. Will be calculated based on children-data. One entry per child.

< EinnahmenMonatlich > array

lebensUndRentenVersicherungen
optional

< LebensOderRentenversicherungVermoegen > array

mietAusgaben
optional

< MietAusgaben > array

privateDarlehen
optional

< Verbindlichkeit > array

privateKrankenversicherung
optional

< AusgabenMonatlich > array

ratenkredite
optional

< Verbindlichkeit > array

sonstigeAusgaben
optional

< AusgabenMonatlich > array

sonstigeEinnahmen
optional

< EinnahmenMonatlich > array

sonstigeVerbindlichkeiten
optional

< Verbindlichkeit > array

sonstigeVermoegen
optional

< Vermoegen > array

sparplaene
optional

< Sparplaene > array

unbefristeteZusatzRenten
optional

< EinnahmenMonatlich > array

unterhaltsVerpflichtungen
optional

< AusgabenMonatlich > array

variableEinkuenfte
optional

< EinnahmenMonatlich > array

versicherungsAusgaben
optional

< AusgabenMonatlich > array

wertpapiere
optional

< Wertpapiere > array

ImmobilieVerknuepfung

Name Schema

id
optional

string

KfwDarlehen

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

bereitstellungsZins
required

number

bereitstellungsZinsFreieZeitInMonaten
required

integer (int32)

kfwEnergieEffizienzGruppe
optional

only with PROGRAMM_261, PROGRAMM_262

enum (NEUBAU, SANIERUNG, STANDARD)

kfwEnergieEffizienzStandard
optional

only with PROGRAMM_153, PROGRAMM_261, PROGRAMM_262

enum (KLIMAFREUNDLICH_QNG, KLIMAFREUNDLICH_STANDARD, STANDARD_100, STANDARD_100_EEK, STANDARD_40, STANDARD_40_EEK, STANDARD_40_NH, STANDARD_40_PLUS, STANDARD_55, STANDARD_55_EEK, STANDARD_70, STANDARD_70_EEK, STANDARD_85, STANDARD_85_EEK, STANDARD_DENKMAL, STANDARD_DENKMAL_EEK)

kfwProgramm
required

enum (PROGRAMM_124, PROGRAMM_151, PROGRAMM_152, PROGRAMM_153, PROGRAMM_159, PROGRAMM_167, PROGRAMM_261, PROGRAMM_262, PROGRAMM_297, PROGRAMM_298, PROGRAMM_300, PROGRAMM_308, PROGRAMM_358, PROGRAMM_359)

kfwSanierungsFahrplanLiegtVor
optional

only with PROGRAMM_261, PROGRAMM_262

boolean

laufzeitKalkulatorischInJahren
required

integer (int32)

rateMonatlichInDerTilgungsfreienAnlaufzeit
required

number

tilgungsFreieAnlaufJahre
required

integer (int32)

zinsBindungInJahren
required

integer (int32)

KfwKonditionsReservierung

Name Description Schema

erfolgreichReserviert
optional

TRUE if reservation is commited by KfW-API, FALSE if errors occurs, null if no reservation was called

boolean

gueltigBis
optional

end of reservation date

string (date)

reservierungsMeldung
optional

error message, null if no error occured

string

sofortbestaetigungId
optional

SofortbestätigungID of KfW for successful reservation

string

Kind

Name Schema

geburtsdatum
optional

string (date)

kindergeldWirdBezogen
optional

boolean

name
optional

string

unterhaltsEinnahmenBetragMonatlich
optional

number

LebensOderRentenversicherungVermoegen

Name Description Schema

id
optional

string

maximalAufzuloesenderBetrag
optional

number

praemieMonatlich
optional

number

rueckkaufsWertAktuell
optional

number

tarif
optional

name of tariff

string

typ
optional

enum (FONDSGEBUNDENE_LEBENSVERSICHERUNG, FONDSGEBUNDENE_RENTENVERSICHERUNG, KAPITALBILDENDE_LEBENSVERSICHERUNG, KAPITALBILDENDE_RENTENVERSICHERUNG, RISIKO_LEBENSVERSICHERUNG)

vermoegensEinsatz
optional

enum (ABTRETEN, AUFLOESEN, KEIN_EINSATZ)

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

versicherungsGesellschaft
optional

string

versicherungsSumme
optional

number

vertragsBeginn
optional

contract start

string (date)

vertragsEnde
optional

string (date)

vertragsNummer
optional

contract number

string

verwaltungsgebuehrenJaehrlich
optional

number

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

LegitimationsDaten

Name Description Schema

ausstellendeBehoerde
optional

string

ausstellungsdatum
optional

string (date)

ausweisArt
optional

enum (ANDERE, PERSONALAUSWEIS, REISEPASS)

ausweisArtBeiAndererAusweis
optional

only with ausweisArt = ANDERE

string

ausweisNummer
optional

string

Link

Name Schema

href
optional

string

type
optional

string

Links

Name Schema

self
optional

Link

Meldung

Name Description Schema

kategorie
optional

error-category, possible values: AUSZAHLUNGS_VORAUSSETZUNG,MACHBAR,MACHBARKEITS_HINWEIS,ANPASSUNG_KUNDENWUNSCH,ANPASSUNG_VERTRIEBSWUNSCH,UNBERUECKSICHTIGTE_ANGABE,KONDITIONEN_UNTER_VORBEHALT_VOLLSTAENDIGER_DATEN,KONDITIONEN_UNTER_VORBEHALT_EXTERNER_SCHNITTSTELLEN,MACHBARKEIT_UNTER_VORBEHALT_VOLLSTAENDIGER_DATEN,MACHBARKEIT_UNTER_VORBEHALT_EXTERNER_SCHNITTSTELLEN,MACHBAR_UNTER_VORBEHALT_PRODUZENT,NICHT_MACHBAR,NICHT_ANBIETBAR, new values are possible

string

kreditEntscheider
optional

ProduktAnbieter

produktAnbieter
optional

ProduktAnbieter

text
optional

string

MietAusgaben

Name Description Schema

ausgabenMonatlich
optional

number

entfallenMitFinanzierung
optional

boolean

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

MiteigentumsAnteil

Name Schema

anteil
optional

number (double)

gesamt
optional

integer (int32)

Modernisierung

Name Description Schema

jahrDerModernisierung
optional

string

modernisierungGrad
optional

allowed values: UEBERWIEGEND,UMFASSEND,MITTEL,EINFACH. (More values can be attached)

enum (EINFACH, MITTEL, UEBERWIEGEND, UMFASSEND)

modernisierungsArt
optional

allowed values: KERNSANIERUNG, DACHERNEUERUNG, FENSTER, ROHRLEITUNGEN, HEIZUNG, WAERMEDAEMMUNG, BAEDER, INNENAUSBAU, RAUMAUFTEILUNG. (More values can be attached)

enum (BAEDER, DACHERNEUERUNG, FENSTER, HEIZUNG, INNENAUSBAU, KERNSANIERUNG, RAUMAUFTEILUNG, ROHRLEITUNGEN, WAERMEDAEMMUNG)

ModernisierungsAngaben

Name Description Schema

modernisierungsGrad
optional

allowed values: GERING,MITTEL,HOCH. (More values can be attached)

string

modernisierungsJahr
optional

year of refurbishment of the property. 4-digit year
Example : "2022"

string

NachrangigesExternesDarlehen

Name Description Schema

darlehensBetrag
optional

number

darlehensGeber
optional

The name of the external lender (company name). There is no corresponding relationship with a partner on the Europace platform.

string

id
optional

string

laufzeitEnde
optional

string (date)

rateMonatlich
optional

number

typ
optional

allowed values: ARBEITGEBERDARLEHEN,BAUSPARDARLEHEN,OEFFENTLICHES_DARLEHEN,RATENKREDIT. (More values can be attached)

string

zinsBindung
optional

ZinsBindung

NachrichtDTO

Name Description Schema

text
required

content of message
Length : 1 - 2000

string

Objektbewertung

property valuation

Name Description Schema

immobilie
optional

property

ImmobilieVerknuepfung

marktwert
optional

market value

number

quelle
optional

source

ObjektbewertungsQuelle

ObjektbewertungsQuelle

source of property valuation

Name Description Schema

name
optional

name of source; currently known names: 'Value', 'VDP', 'BaufiSmart-Wertermittlung'

string

referenz
optional

reference of source; optional; may reference additional valuation data from external valuation sources, like e.g. Value

string

PaginationLinks

Name Schema

next
optional

Link

prev
optional

Link

self
optional

Link

Partner

information about partner, for more use Partner API

Name Description Schema

_links
optional

Links

anrede
optional

salutation

string

anschrift
optional

adress

Anschrift

aufsichtsBehoerde
optional

regulating authority

string

email
optional

email

string

externerKreditSachbearbeiterId
optional

external loan officer id

string

firmierung
optional

company

string

mitarbeiterKreditinstitut
optional

the partner works for a banking institute

boolean

nachname
optional

sur name

string

partnerId
optional

string

partnerKennzeichen
optional

list of partner-identifiers

< PartnerKennzeichen > array

registrierungsNummer
optional

registration number

string

telefonnummer
optional

phone number

string

vertriebsOrganisation
optional

sales organization

string

vertriebsOrganisationPartnerId
optional

sales organisation partnerId to get more data with Partner API

string

vertriebsOrganisationsId
optional

identfier sales organization

string

vorname
optional

first name

string

webseite
optional

string

PartnerKennzeichen

Name Description Schema

name
optional

name of partner-identifier

string

wert
optional

value of partner-identifier

string

PatchOperation

A JSONPatch document as defined by RFC 6902 (see http://jsonpatch.com/). Beispiel: { "op": "replace", "path": "/antragsReferenz", "value": "123-ABC"" }

Name Description Schema

from
optional

string

op
optional

executed operation

enum (add, copy, move, remove, replace, test)

path
optional

JSON-Path in Antrag. Valid pathes: '/antragsReferenz', '/weitereAntragsReferenzen', '/status', '/status/antragsteller', '/status/produktAnbieter', '/status/antragstellerAblehnungsgrund', '/status/produktanbieterAblehnungsgrund', '/kreditSachbearbeiter/partnerId', '/kreditSachbearbeiter/externerPartner', '/voraussichtlicheBearbeitung'.

string

value
optional

Value to be set or replaced. Allows: string, number or JSON object
Example : "\"ABC123\", 1234, {\"antragsteller\": \"BEANTRAGT\"}"

object

Postadresse

Name Description Schema

hausnummer
optional

housenumber

string

ort
optional

place

string

postleitzahl
optional

zip-code

string

strasse
optional

street

string

PrivatDarlehen

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

laufzeitKalkulatorischInMonaten
required

integer (int32)

zinsBindungInMonaten
required

integer (int32)

Problem

Name Schema

message
optional

string

statusCode
optional

integer (int32)

statusMessage
optional

string

traceId
optional

string

violations
optional

< Violation > array

ProduktAnbieter

loan provider

Name Description Schema

anrede
optional

salutation

string

anschrift
optional

adress

Anschrift

aufsichtsBehoerde
optional

regulating authority

string

email
optional

email

string

externerKreditSachbearbeiterId
optional

external loan officer id

string

firmierung
optional

company

string

mitarbeiterKreditinstitut
optional

the partner works for a banking institute

boolean

nachname
optional

sur name

string

partnerId
optional

string

partnerKennzeichen
optional

list of partner-identifiers

< PartnerKennzeichen > array

produktAnbieterId
optional

loan provider id

string

produktAnbieterKurzName
optional

loan provider short name

string

registrierungsNummer
optional

registration number

string

telefonnummer
optional

phone number

string

vertriebsOrganisation
optional

sales organization

string

vertriebsOrganisationPartnerId
optional

sales organisation partnerId to get more data with Partner API

string

vertriebsOrganisationsId
optional

identfier sales organization

string

vorname
optional

first name

string

webseite
optional

string

Provision

Name Description Schema

europaceGebuehren
optional

europace fee

number

europaceGebuehrenSindSteuerpflichtig
optional

TRUE if europace fee is value-added tax (VAT) relevant

boolean

kundenbetreuerProvision
optional

advisors commissions

number

tippgeberProvision
optional

tipster commissions

number

vertriebsProvisionGesamt
optional

sum of sales commissions

number

RechteAbteilung2

Name Schema

beschreibung
optional

string

betrag
optional

number

RegionalFoerderDarlehen

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

bereitstellungsZins
required

number

bereitstellungsZinsFreieZeitInMonaten
required

integer (int32)

laufzeitKalkulatorischInJahren
required

integer (int32)

rateMonatlichInDerTilgungsfreienAnlaufzeit
required

number

regionalFoerderbankProgramm
required

enum (L_BANK_KOMBI_DARLEHEN_WOHNEN, L_BANK_WOHNEN_MIT_KIND, NRW_BANK_GEBAEUDESANIERUNG, NRW_BANK_NACHHALTIG_WOHNEN, NRW_BANK_WOHNEIGENTUM)

tilgungsFreieAnlaufJahre
required

integer (int32)

zinsBindungInJahren
required

integer (int32)

RisikoAbsicherung

Name Schema

abgesichertesRisiko
optional

enum (ARBEITSLOSIGKEIT, ARBEITSUNFAEHIGKEIT, ASSISTANCE_ARBEITSLOSIGKEIT, ASSISTANCE_ARBEITSUNFAEHIGKEIT, INVALIDITAET, SCHWERE_KRANKHEIT, TODESFALL)

auszahlungsBetrag
optional

number

auszahlungsTurnus
optional

enum (EINMALIG, HALBJAEHRLICH, JAEHRLICH, MONATLICH, VIERTELJAEHRLICH)

praemienAnteil
optional

number

SchufaErgebnis

Name Description Schema

antragstellerUnbekannt
optional

TRUE if customer is not identifiable by schufa

boolean

inManuellerNachbehandlung
optional

TRUE if schufa rating process is manually operated

boolean

score
optional

schufa rating score

string

SituationNachRenteneintritt

Name Schema

gesetzlicheRenteMonatlich
optional

number

privateRenteMonatlich
optional

number

rentenBeginn
optional

string (date)

sonstigesEinkommenMonatlich
optional

number

SonderZahlung

Name Schema

anzahl
optional

integer (int32)

betrag
optional

number

termin
optional

string (date)

zahlweise
optional

enum (EINMALIG, HALBJAEHRLICH, JAEHRLICH, MONATLICH, VIERTELJAEHRLICH)

SparPhase

Name Schema

guthabenBeiZuteilung
optional

number

sparBeitragMonatlich
optional

number

sparPhaseInJahren
optional

integer (int32)

Sparplaene

Name Description Schema

aktuellerWert
optional

number

beitragMonatlich
optional

number

maximalAufzuloesenderWert
optional

number

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

Staat

Name Description Schema

isoCountryCode
optional

ISO 3166-1 alpha-2 code

string

name
optional

string

StatusDTO

Name Schema

antragsteller
required

enum (BEANTRAGT, NICHT_ANGENOMMEN, UNTERSCHRIEBEN, WIDERRUFEN)

antragstellerAblehnungsgrund
optional

enum (ANDERER_GRUND, ANDERES_ANGEBOT_ANGENOMMEN, ANGEBOT_WETTBEWERBER, BEARBEITUNGSZEIT, FINANZIERUNG_WIRD_ANGEPASST, KONDITIONEN_UNPASSEND, KUNDE_NICHT_ERREICHBAR, OBJEKT_NICHT_INTERESSANT, OBJEKT_NICHT_VERFUEGBAR)

kommentar
optional

string

produktAnbieter
required

enum (ABGELEHNT, NICHT_BEARBEITET, UNTERSCHRIEBEN, ZURUECKGESTELLT)

produktanbieterAblehnungsgrund
optional

enum (FINANZIELLE_SITUATION, GEGENANGEBOT, KEINE_ANGABE, KRITERIEN, NEGATIV_MERKMAL, UNTERLAGEN_UNVOLLSTAENDIG, WERTERMITTLUNG)

Tilgung

Name Description Schema

anfaenglicheTilgung
optional

if null or 0: suspended redemption

number

sonderTilgungJaehrlich
optional

only with darlehensArt IN [ANNUITAETEN_DARLEHEN,FORWARD_DARLEHEN] and NO redemption substitute

number

tilgungsBeginnAm
optional

redemption date

string (date)

tilgungsErsatz
optional

not with PRIVAT_DARLEHEN

TilgungsErsatz

volltilgerDarlehen
optional

only with darlehensArt IN [ANNUITAETEN_DARLEHEN,FORWARD_DARLEHEN]
Example : true

boolean

TilgungsErsatz

Name Description Schema

id
optional

Id of redemption substitute, part of assets in houshold or a new building society saving loan offer.

string

typ
optional

redemption substitute type, eg BAUSPARVERTRAG or KAPITALBILDENDE_LEBENSVERSICHERUNG

string

TilgungsPhase

Name Schema

bausparDarlehenSumme
optional

number

sollZinsNachZuteilung
optional

number

tilgungsBeitragMonatlich
optional

number

tilgungsPhaseInJahren
optional

integer (int32)

VariablesDarlehen

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

bereitstellungsZins
optional

number

bereitstellungsZinsFreieZeitInMonaten
optional

integer (int32)

laufzeitKalkulatorischInJahren
required

integer (int32)

tilgungsBeginnAm
optional

Example : "2020-03-28"

string (date-time)

Verbindlichkeit

liability

Name Description Schema

glaeubiger
optional

string

laufzeitEnde
optional

string (date)

rateMonatlich
optional

number

restschuld
optional

number

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

wirdAbgeloest
optional

boolean

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

VermietungsInformationen

Name Schema

mieteinnahmenNettoKaltMonatlich
optional

number

nutzungsArt
optional

enum (EIGENGENUTZT, TEIL_VERMIETET, VERMIETET)

vermieteteFlaeche
optional

number

Vermoegen

Name Description Schema

aktuellerWert
optional

number

maximalAufzuloesenderWert
optional

number

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

VermoegenVerbindlichkeit

Name Schema

aktuellerWert
optional

number

anrechnungFuerBlankoAnteil
optional

number

bezeichner
optional

string

kontonummer
optional

string

vermoegensTyp
optional

enum (VERBINDLICHKEIT, VERMOEGEN)

VermoegenVerbindlichkeiten

Name Schema

vermoegenOderVerbindlichkeiten
optional

< VermoegenVerbindlichkeit > array

VersicherungsZeitraum

Name Schema

beginn
optional

string (date)

dauerInMonaten
optional

integer (int32)

ende
optional

string (date)

Vertrieb

information about distribution channel, for more use Partner API

Name Schema

_links
optional

Links

orderid
optional

integer (int32)

organisationsName
optional

string

partnerId
optional

string

VertriebsStruktur

distribution channels of advisor and/or clerk at creation date of application

Name Description Schema

_links
optional

Links

vertriebeDesAnsprechpartners
optional

distribution channels of clerk at creation date of application

< Vertrieb > array

vertriebeDesVermittlers
optional

distribution channels of advisor at creation date of application

< Vertrieb > array

Violation

Name Schema

field
optional

string

message
optional

string

Vorhaben

Name Schema

eigenleistungWennNeubauOderModernisierungsmassnahmen
optional

number

externeBausparAngebote
optional

< BausparAngebot > array

finanzbedarf
optional

Finanzbedarf

nachfinanzierung
optional

boolean

nachrangigeExterneDarlehen
optional

< NachrangigesExternesDarlehen > array

verwendungszweck
optional

enum (ANSCHLUSSFINANZIERUNG, KAPITALBESCHAFFUNG, KAUF, KAUF_NEUBAU_VOM_BAUTRAEGER, MODERNISIERUNG_UMBAU_ANBAU, NEUBAU)

Wertpapiere

Name Description Schema

aktuellerWert
optional

number

dividendenJaehrlich
optional

number

maximalAufzuloesenderWert
optional

number

vermoegensTyp
optional

asset type, redundant entry serves as an additional filter criterion

enum (VERBINDLICHKEIT, VERMOEGEN)

zahlungsTyp
optional

payment type, redundant entry serves as an additional filter criterion

enum (AUSGABE, EINNAHME)

Zahlungsplaene

Name Schema

_links
optional

Links

zahlungsplaene
optional

< zahlungsplan > array

ZinsBindung

Name Schema

endetAm
optional

string (date)

jahre
optional

integer (int32)

monate
optional

integer (int32)

restschuldNachZinsBindungsEnde
optional

number

ZugrundeliegendeDatenZumAntrag

Name Schema

_links
optional

Links

bankverbindung
optional

Bankverbindung

finanzierungsObjekt
optional

FinanzierungsObjekt

haushalte
optional

< Haushalt > array

vorhaben
optional

Vorhaben

ZwischenFinanzierung

extends GegenangebotDarlehen

Polymorphism : Inheritance
Discriminator : darlehensTyp

Name Description Schema

anfaenglicheTilgung
required

number

darlehensBetrag
required

number

darlehensTyp
required

The value of this enum determines which class is being used. See the implementing classes for more details.

enum (ANNUITAETEN_DARLEHEN, FORWARD_DARLEHEN, KFW_DARLEHEN, PRIVAT_DARLEHEN, REGIONAL_FOERDER_DARLEHEN, VARIABLES_DARLEHEN, ZWISCHEN_FINANZIERUNG)

effektivZins
required

number

produktDetails
optional

description for advisor

string

rateMonatlich
required

number

sollZins
required

number

vertriebsProvisionGesamtAbsolut
required

sum of sales commission (advisor and overhead), europace fee is excluded

number

maximaleLaufzeitInMonaten
optional

integer (int32)

zahlungsplan

redemption plan

Name Schema

bausteinId
optional

string

eintraege
optional

< Eintrag > array

gesamtSumme
optional

Eintrag

sparplanSummenEintragZumZuteilungsZeitpunkt
optional

Eintrag

summeEndeDerZinsbindung
optional

Eintrag

typ
optional

enum (TILGUNGSPLAN)