API docs by Redocly

Anträge API (2.84)

Download OpenAPI specification:

Europace AG: devsupport@europace2.de URL: https://docs.api.europace.de

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

Antraege

All about mortage-applications and -approvals.

get list of all applications

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

Authorizations:
oauth_securityoauth_security
query Parameters
datenKontext
string
Default: "ECHT_GESCHAEFT"
Enum: "TEST_MODUS" "ECHT_GESCHAEFT"

usage mode

angenommenNach
string
Example: angenommenNach=2016-03-11T10:57:45Z

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

angenommenVor
string
Example: angenommenVor=2016-03-11T10:57:45Z

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

antragsReferenz
string

filter by your own reference

sort
string
Default: "absteigend"

sort mode, default descending

page
integer <int32>
Default: 0
limit
integer <int32>
Default: 10
produktAnbieter
string

filter by loan provider

aenderungSeit
string
Example: aenderungSeit=2016-03-11T10:57:45Z

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

aenderungBis
string
Example: aenderungBis=2016-03-11T10:57:45Z

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

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "antraege": [
    ]
}

get list of all applications of a case

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

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "antraege": [
    ]
}

get list of approvals of an application

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

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "antraege": [
    ]
}

get application

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

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

iterator-application

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "angebot": {
    },
  • "ansprechpartner": {
    },
  • "antragsNummer": "string",
  • "antragsReferenz": "string",
  • "beratung": {
    },
  • "datenKontext": "TEST_MODUS",
  • "dokumente": [
    ],
  • "entscheidungsreifeVomVertriebSignalisiert": true,
  • "kreditSachbearbeiter": {
    },
  • "letzteAenderung": "2019-08-24T14:15:22Z",
  • "letztesEreignis": "2019-08-24T14:15:22Z",
  • "produktAnbieter": {
    },
  • "prolongation": true,
  • "status": {
    },
  • "vermittler": {
    },
  • "vertriebsStrukturZumZeitpunktDerAnnahme": {
    },
  • "voraussichtlicheBearbeitung": "2019-08-24",
  • "vorgangsReferenz": "string",
  • "weitereAntragsReferenzen": {
    },
  • "zeitpunktDerAnnahme": "2019-08-24T14:15:22Z",
  • "zugrundeliegendeDaten": {
    }
}

patch application

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.

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234/1/2

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

approval-iterator

Request Body schema:
required
Array
from
string
op
string
Enum: "add" "remove" "replace" "copy" "move" "test"

executed operation

path
string

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

value
object

Value to be set or replaced. Allows: string, number or JSON object

Responses

Request samples

Content type
[
  • {
    }
]

get offer

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

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

approval-iterator

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "absicherungen": [
    ],
  • "bausparvertraege": [
    ],
  • "beleihungsRechnung": {
    },
  • "bewertungDesAngebots": "ANGEBOT_ENTSPRICHT_DER_EMPFEHLUNG_DES_KUNDENBETREUERS",
  • "bonitaet": [
    ],
  • "darlehen": [
    ],
  • "erzeugtAm": "2019-08-24T14:15:22Z",
  • "kennung": "string",
  • "machbarkeitsStatus": "MACHBAR",
  • "meldungen": [
    ],
  • "pruefungsErgebnisse": [
    ]
}

get redemption plan

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

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

approval-iterator

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "zahlungsplaene": [
    ]
}

get clerk

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

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

application-id

teilantrag
required
integer <int32>
Example: 1

iterator-application

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "anrede": "string",
  • "anschrift": {
    },
  • "aufsichtsBehoerde": "string",
  • "email": "string",
  • "externerKreditSachbearbeiterId": "string",
  • "firmierung": "string",
  • "mitarbeiterKreditinstitut": true,
  • "nachname": "string",
  • "partnerId": "string",
  • "partnerKennzeichen": [
    ],
  • "registrierungsNummer": "string",
  • "telefonnummer": "string",
  • "vertriebsOrganisation": "string",
  • "vertriebsOrganisationPartnerId": "string",
  • "vertriebsOrganisationsId": "string",
  • "vorname": "string",
  • "webseite": "string"
}

create counteroffer

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.

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

approval-iterator

Request Body schema: application/json
required
required
Array of objects (GegenangebotDarlehen)
kennung
string

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

Responses

Request samples

Content type
application/json
{
  • "darlehen": [
    ],
  • "kennung": "string"
}

Response samples

Content type
application/json
"string"

send message

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.

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

iterator-application

query Parameters
required
object (NachrichtDTO)

Responses

send message

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.

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

iterator-application

Request Body schema: application/json
required
text
required
string [ 1 .. 2000 ] characters

content of message

Responses

Request samples

Content type
application/json
{
  • "text": "string"
}

set state

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

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.

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

iterator-application

query Parameters
required
object (StatusDTO)

Responses

set state

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

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.

Authorizations:
oauth_securityoauth_security
path Parameters
vorgang
required
string
Example: AB1234

case-id

antrag
required
integer <int32>
Example: 3

iterator-solution

teilantrag
required
integer <int32>
Example: 1

iterator-application

Request Body schema: application/json
required
antragsteller
required
string
Enum: "BEANTRAGT" "UNTERSCHRIEBEN" "NICHT_ANGENOMMEN" "WIDERRUFEN"
antragstellerAblehnungsgrund
string
Enum: "ANGEBOT_WETTBEWERBER" "KONDITIONEN_UNPASSEND" "KUNDE_NICHT_ERREICHBAR" "OBJEKT_NICHT_INTERESSANT" "OBJEKT_NICHT_VERFUEGBAR" "FINANZIERUNG_WIRD_ANGEPASST" "ANDERES_ANGEBOT_ANGENOMMEN" "ANDERER_GRUND" "BEARBEITUNGSZEIT"
kommentar
string
produktAnbieter
required
string
Enum: "NICHT_BEARBEITET" "UNTERSCHRIEBEN" "ABGELEHNT" "ZURUECKGESTELLT"
produktanbieterAblehnungsgrund
string
Enum: "FINANZIELLE_SITUATION" "NEGATIV_MERKMAL" "WERTERMITTLUNG" "KRITERIEN" "UNTERLAGEN_UNVOLLSTAENDIG" "GEGENANGEBOT" "KEINE_ANGABE"

Responses

Request samples

Content type
application/json
{
  • "antragsteller": "BEANTRAGT",
  • "antragstellerAblehnungsgrund": "ANGEBOT_WETTBEWERBER",
  • "kommentar": "string",
  • "produktAnbieter": "NICHT_BEARBEITET",
  • "produktanbieterAblehnungsgrund": "FINANZIELLE_SITUATION"
}