⚠️ You’ll find German domain-specific terms in the documentation, for translations and further explanations please refer to our glossary
APIs for updating data in KreditSmart-Vorgängen. The URL for this service is:
https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
All APIs documented here are GraphQL-APIs .
⚠️ This API is continuously developed. Therefore we expect all users to align with the “Tolerant Reader Pattern ”, which requires clients to be tolerant towards compatible API changes when reading and processing the data. This means:
unknown properties must not result in errors
Strings with a restricted set of values (Enums) must support new unknown values
sensible usage of HTTP status codes, even if they are not explicitly documented
These APIs are secured by the OAuth 2.0 client credentials flow using the Authorization-API . To use these APIs your OAuth2-Client needs the following scopes:
Scope | Label in Partnermanagement | Description |
---|---|---|
privatkredit:vorgang:schreiben | KreditSmart-Vorgänge anlegen/verändern | Scope for updating a Vorgang |
These APIs accept data with the content-type application/json with UTF-8 encoding. The fields inside a block can be sent in any order.
The APIs support all common GraphQL formats. More information can be found at https://graphql.org/learn/queries/ .
The body of a GraphQL request contains the field query
, which includes the GraphQL query as a String. Parameters can be set directly in the query or defined as variables. The variables can be sent
in the variables
field of the body as a key-value map. All our examples use variables.
{
"query": "...",
"variables": { ... }
}
One of the special features in GraphQL is that most errors are not reflected via HTTP error codes. In many cases you receive a status code 200, even though an error has occurred. These GraphQL errors
can be found in the errors
field of the response body. More information about error codes can be found here
.
Error Code | Message | Description |
---|---|---|
401 | Unauthorized | Authentication failed |
403 | Forbidden | The API client misses a scope |
415 | Unsupported MediaType | The wrong content type was used |
Error Code | Message | Description |
---|---|---|
400 | Bad Request | Request format is invalid (mandatory fields are missing, wrong parameter names or values, …) |
403 | Forbidden | The authenticated user does not have sufficient rights |
404 | Not Found | The Vorgang does not exist |
410 | Gone | The Vorgang was deleted in the meantime |
AKTIV
, which means it must not be archived.antragstellerId
has to refer to an existing Antragsteller in the Vorgang.addAntragsteller ( vorgangsnummer: String!, antragsteller: Antragsteller ! ) -> BasicResponse !
Add an Antragsteller to a Vorgang. The Response contains the
id
of the created Antragsteller. Thisid
can be used to update or delete this Antragsteller.
deleteAntragsteller ( vorgangsnummer: String!, id: String! ) -> BasicResponse !
Delete an existing Antragsteller. The Antragsteller is referenced by the
id
.
updatePersonendaten ( vorgangsnummer: String!, antragstellerId: String!, personendaten: Personendaten ! ) -> BasicResponse !
This mutation is for updating the Personendaten for an Antragsteller of a Vorgang.
POST https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
Authorization: Bearer xxxx
Content-Type: application/json
{
"query": "mutation personendaten($vorgangsnummer: String!, $antragstellerId: String!) {
updatePersonendaten(vorgangsnummer: $vorgangsnummer, antragstellerId: $antragstellerId, personendaten: {
vorname: "Max"
nachname: "Mustermann"
}) {
messages
}
}",
"variables": {
"vorgangsnummer": "ABC123",
"antragstellerId": "12345678-abcd-wxyz-0987-1234567890ab"
}
}
{
"data": {
"messages": []
},
"errors": []
}
updateWohnsituation ( vorgangsnummer: String!, antragstellerId: String!, wohnsituation: Wohnsituation ! ) -> BasicResponse !
This mutation is for updating the Wohnsituation for an Antragsteller of a Vorgang.
POST https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
Authorization: Bearer xxxx
Content-Type: application/json
{
"query": "mutation wohnsituation($vorgangsnummer: String!, $antragstellerId: String!) {
updateWohnsituation(vorgangsnummer: $vorgangsnummer, antragstellerId: $antragstellerId, wohnsituation: {
wohnart: ZUR_MIETE
anzahlPersonenImHaushalt: 1
}) {
messages
}
}",
"variables": {
"vorgangsnummer": "ABC123",
"antragstellerId": "12345678-abcd-wxyz-0987-1234567890ab"
}
}
updateHerkunft ( vorgangsnummer: String!, antragstellerId: String!, herkunft: Herkunft ! ) -> BasicResponse !
This mutation is for updating the Herkunft for an Antragsteller of a Vorgang.
POST https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
Authorization: Bearer xxxx
Content-Type: application/json
{
"query": "mutation herkunft($vorgangsnummer: String!, $antragstellerId: String!) {
updateHerkunft(vorgangsnummer: $vorgangsnummer, antragstellerId: $antragstellerId, herkunft: {
staatsangehoerigkeit: DE
steuerId: "11345678904"
}) {
messages
}
}",
"variables": {
"vorgangsnummer": "ABC123",
"antragstellerId": "12345678-abcd-wxyz-0987-1234567890ab"
}
}
{
"data": {
"messages": []
},
"errors": []
}
updateBeschaeftigung ( vorgangsnummer: String!, antragstellerId: String!, beschaeftigung: Beschaeftigung ! ) -> BasicResponse !
This mutation is for updating the Beschaeftigung for an Antragsteller of a Vorgang.
POST https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
Authorization: Bearer xxxx
Content-Type: application/json
{
"query": "mutation beschaeftigung($vorgangsnummer: String!, $antragstellerId: String!) {
updateBeschaeftigung(vorgangsnummer: $vorgangsnummer, antragstellerId: $antragstellerId, beschaeftigung: {
beschaeftigungsart:ARBEITER,
arbeiter: {
beschaeftigungsverhaeltnis: {
nettoeinkommenMonatlich: 2345.67,
befristung: UNBEFRISTET,
beschaeftigtSeit: "2009-01-02",
arbeitgeber: {
name: "Firmenname",
branche: INFORMATION_KOMMUNIKATION,
anschrift: {
ort: "Berlin"
}
}
}
}
}) {
messages
}
}",
"variables": {
"vorgangsnummer": "ABC123",
"antragstellerId": "12345678-abcd-wxyz-0987-1234567890ab"
}
}
{
"data": {
"messages": []
},
"errors": []
}
AKTIV
, which means it must not be archived.antragstellerIds
has to correspond to an Antragsteller in the Vorgang.id
has to correspond to a Haushaltsposition in the Vorgang with the corresponding type.addBausparvertrag ( vorgangsnummer String!, bausparvertrag Bausparvertrag ! ) -> BasicCreatedResponse !
Add a Bausparvertrag to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateBausparvertrag ( vorgangsnummer: String!, id: String!, bausparvertrag Bausparvertrag ! ) -> BasicResponse !
Update a existing Bausparvertrag. The Haushaltsposition is referenced by the
id
.
deleteBausparvertrag( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete a existing Bausparvertrag. The Haushaltsposition is referenced by the
id
.
If the finanzierungszweck
of the Vorgang is FAHRZEUGKAUF
then this position cannot be refinanced. This means that abloesen
cannot be true
and will be set to false
if it is. Related fields
will not be saved.
Related fields are bic
and iban
.
If iban
or bic
are invalid, the value will be ignored and set to null
.
addDispositionskredit ( vorgangsnummer String!, dispositionskredit Dispositionskredit ! ) -> BasicCreatedResponse !
Add a Dispositionskredit to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateDispositionskredit ( vorgangsnummer: String!, id: String!, dispositionskredit Dispositionskredit ! ) -> BasicResponse !
Update an existing Dispositionskredit. The Haushaltsposition is referenced by the
id
.
deleteDispositionskredit ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Dispositionskredit. The Haushaltsposition is referenced by the
id
.
ehegattenunterhalt
can only be related to one Antragsteller. If you provide more than one antragstellerId
you will receive a GraphQL error with the error
code 422 - UNPROCESSABLE ENTITY
.addEhegattenunterhalt ( vorgangsnummer String!, ehegattenunterhalt Ehegattenunterhalt ! ) -> BasicCreatedResponse !
Add an Ehegattenunterhalt to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateEhegattenunterhalt ( vorgangsnummer: String!, id: String!, ehegattenunterhalt Ehegattenunterhalt ! ) -> BasicResponse !
Update an existing Ehegattenunterhalt. The Haushaltsposition is referenced by the
id
.
deleteEhegattenunterhalt ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Ehegattenunterhalt. The Haushaltsposition is referenced by the
id
.
einkunftAusNebentätigkeit
can only be related to one Antragsteller. If you provide more than one antragstellerId
you will receive a GraphQL error with the error
code 422 - UNPROCESSABLE ENTITY
.addEinkunftAusNebentaetigkeit ( vorgangsnummer String!, einkunftAusNebentaetigkeit EinkunftAusNebentaetigkeit ! ) -> BasicCreatedResponse !
Add an Einkunft aus Nebentätigkeit to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateEinkunftAusNebentaetigkeit ( vorgangsnummer: String!, id: String!, einkunftAusNebentaetigkeit EinkunftAusNebentaetigkeit ! ) -> BasicResponse !
Update an existing Einkunft aus Nebentätigkeit. The Haushaltsposition is referenced by the
id
.
deleteEinkunftAusNebentaetigkeit ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Einkunft aus Nebentätigkeit. The Haushaltsposition is referenced by the
id
.
addImmobilie ( vorgangsnummer: String!, immobilie: Immobilie ! ) -> BasicCreatedResponse !
Add an Immobilie to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateImmobilie ( vorgangsnummer: String!, id: String!, immobilie: Immobilie ! ) -> BasicResponse !
Update an existing Immobilie. The Haushaltsposition is referenced by the
id
.
deleteImmobilie ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Immobilie. The Haushaltsposition is referenced by the
id
.
addKind ( vorgangsnummer String!, kind Kind ! ) -> BasicCreatedResponse !
Add a Kind to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateKind ( vorgangsnummer: String!, id: String!, kind Kind ! ) -> BasicResponse !
Update an existing Kind. The Haushaltsposition is referenced by the
id
.
deleteKind ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Kind. The Haushaltsposition is referenced by the
id
.
updateKontoverbindung ( vorgangsnummer: String!, kontoverbindung Kontoverbindung ! ) -> BasicResponse !
Update the Kontoverbindung.
iban
or bic
are invalid, the value will be ignored and set to null
.If the finanzierungszweck
of the Vorgang is FAHRZEUGKAUF
then this position cannot be refinanced. This means that abloesen
cannot be true
and will be set to false
if it is. Related fields
will not be saved.
Related fields are bic
and iban
.
If iban
or bic
are invalid, the value will be ignored and set to null
.
addKreditkarte ( vorgangsnummer String!, kreditkarte Kreditkarte ! ) -> BasicCreatedResponse !
Add a Kreditkarte to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateKreditkarte ( vorgangsnummer: String!, id: String!, kreditkarte Kreditkarte ! ) -> BasicResponse !
Update an existing Kreditkarte. The Haushaltsposition is referenced by the
id
.
deleteKreditkarte ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Kreditkarte. The Haushaltsposition is referenced by the
id
.
addLeasing ( vorgangsnummer String!, leasing Leasing ! ) -> BasicCreatedResponse !
Add a Leasing to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateLeasing ( vorgangsnummer: String!, id: String!, leasing Leasing ! ) -> BasicResponse !
Update an existing Leasing. The Haushaltsposition is referenced by the
id
.
deleteLeasing ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Leasing. The Haushaltsposition is referenced by the
id
.
Lebensversicherung ( vorgangsnummer String!, lebensversicherung Lebensversicherung ! ) -> BasicCreatedResponse !
Add a Lebensversicherung to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateLebensversicherung ( vorgangsnummer: String!, id: String!, lebensversicherung Lebensversicherung ! ) -> BasicResponse !
Update an existing Lebensversicherung. The Haushaltsposition is referenced by the
id
.
deleteLebensversicherung ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Lebensversicherung. The Haushaltsposition is referenced by the
id
.
addMietausgabe ( vorgangsnummer String!, mietausgabe Mietausgabe ! ) -> BasicCreatedResponse !
Add a Mietausgabe to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateMietausgabe ( vorgangsnummer: String!, id: String!, mietausgabe Mietausgabe ! ) -> BasicResponse !
Update an existing Mietausgabe. The Haushaltsposition is referenced by the
id
.
deleteMietausgabe ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Mietausgabe. The Haushaltsposition is referenced by the
id
.
privateKrankenversicherung
can only be related to one Antragsteller. If you provide more than one antragstellerId
you will receive a GraphQL error with the error code 422 - UNPROCESSABLE ENTITY
.addPrivateKrankenversicherung ( vorgangsnummer String!, privateKrankenversicherung PrivateKrankenversicherung ! ) -> BasicCreatedResponse !
Add a private Krankenversicherung to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updatePrivateKrankenversicherung ( vorgangsnummer: String!, id: String!, privateKrankenversicherung PrivateKrankenversicherung ! ) -> BasicResponse !
Update an existing private Krankenversicherung. The Haushaltsposition is referenced by the
id
.
deletePrivateKrankenversicherung ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing private Krankenversicherung. The Haushaltsposition is referenced by the
id
.
If the finanzierungszweck
of the Vorgang is FAHRZEUGKAUF
then this position cannot be refinanced. This means that abloesen
cannot be true
and will be set to false
if it is. Related fields
will not be saved.
Related fields are bic
, datumErsteZahlung
, iban
, and urspruenglicherKreditbetrag
.
If iban
or bic
are invalid, the value will be ignored and set to null
.
addRatenkredit ( vorgangsnummer String!, ratenkredit Ratenkredit ! ) -> BasicCreatedResponse !
Add a ratenkredit to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateRatenkredit ( vorgangsnummer: String!, id: String!, ratenkredit Ratenkredit ! ) -> BasicResponse !
Update an existing ratenkredit. The Haushaltsposition is referenced by the
id
.
deleteRatenkredit ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing ratenkredit. The Haushaltsposition is referenced by the
id
.
addSonstigeAusgabe ( vorgangsnummer String!, sonstigeAusgabe SonstigeAusgabe ! ) -> BasicCreatedResponse !
Add a sonstige Ausgabe to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateSonstigeAusgabe ( vorgangsnummer: String!, id: String!, sonstigeAusgabe SonstigeAusgabe ! ) -> BasicResponse !
Update an existing sonstige Ausgabe. The Haushaltsposition is referenced by the
id
.
deleteSonstigeAusgabe ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing sonstige Ausgabe. The Haushaltsposition is referenced by the
id
.
sonstigeEinnahme
can only be related to one Antragsteller. If you provide more than one antragstellerId
you will receive a GraphQL error with the error
code 422 - UNPROCESSABLE ENTITY
.addSonstigeEinnahme ( vorgangsnummer String!, sonstigeEinnahme SonstigeEinnahme ! ) -> BasicCreatedResponse !
Add a sonstige Einnahme to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateSonstigeEinnahme ( vorgangsnummer: String!, id: String!, sonstigeEinnahme SonstigeEinnahme ! ) -> BasicResponse !
Update an existing sonstige Einnahme. The Haushaltsposition is referenced by the
id
.
deleteSonstigeEinnahme ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing sonstige Einnahme. The Haushaltsposition is referenced by the
id
.
If the finanzierungszweck
of the Vorgang is FAHRZEUGKAUF
then this position cannot be refinanced. This means that abloesen
cannot be true
and will be set to false
if it is. Related fields
will not be saved.
Related fields are bic
, datumErsteZahlung
, iban
, and urspruenglicherKreditbetrag
.
If iban
or bic
are invalid, the value will be ignored and set to null
.
addSonstigeVerbindlichkeit ( vorgangsnummer String!, sonstigeVerbindlichkeit SonstigeVerbindlichkeit ! ) -> BasicCreatedResponse !
Add a sonstige Verbindlichkeit to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateSonstigeVerbindlichkeit ( vorgangsnummer: String!, id: String!, sonstigeVerbindlichkeit SonstigeVerbindlichkeit ! ) -> BasicResponse !
Update an existing sonstige Verbindlichkeit. The Haushaltsposition is referenced by the
id
.
deleteSonstigeVerbindlichkeit ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing sonstige Verbindlichkeit. The Haushaltsposition is referenced by the
id
.
unbefristeteZusatzrente
can only be related to one Antragsteller. If you provide more than one antragstellerId
you will receive a GraphQL error with the error
code 422 - UNPROCESSABLE ENTITY
.addUnbefristeteZusatzrente ( vorgangsnummer String!, unbefristeteZusatzrente UnbefristeteZusatzrente ! ) -> BasicCreatedResponse !
Add an UnbefristeteZusatzrente to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateUnbefristeteZusatzrente ( vorgangsnummer: String!, id: String!, unbefristeteZusatzrente UnbefristeteZusatzrente ! ) -> BasicResponse !
Update an existing UnbefristeteZusatzrente. The Haushaltsposition is referenced by the
id
.
deleteUnbefristeteZusatzrente ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing UnbefristeteZusatzrente. The Haushaltsposition is referenced by the
id
.
unterhaltsverpflichtung
can only be related to one Antragsteller. If you provide more than one antragstellerId
you will receive a GraphQL error with the error
code 422 - UNPROCESSABLE ENTITY
.addUnterhaltsverpflichtung ( vorgangsnummer String!, unterhaltsverpflichtung Unterhaltsverpflichtung ! ) -> BasicCreatedResponse !
Add an Unterhaltsverpflichtung to a Vorgang. The Response contains the
id
of the created Haushaltsposition. Thisid
can be used to update or delete this Haushaltsposition.
updateUnterhaltsverpflichtung ( vorgangsnummer: String!, id: String!, unterhaltsverpflichtung Unterhaltsverpflichtung ! ) -> BasicResponse !
Update an existing Unterhaltsverpflichtung. The Haushaltsposition is referenced by the
id
.
deleteUnterhaltsverpflichtung ( vorgangsnummer: String!, id: String!) -> BasicResponse !
Delete an existing Unterhaltsverpflichtung. The Haushaltsposition is referenced by the
id
.
AKTIV
, which means it must not be archived.finanzierungszweck
of the Vorgang has to be FAHRZEUGKAUF
otherwise the update will be ignored.finanzierungszweck
to something other than FAHRZEUGKAUF
will delete a previously saved fahrzeugkauf
.updateFahrzeugkauf ( vorgangsnummer: String!, fahrzeugkauf: Fahrzeugkauf ! ) -> BasicResponse !
Update the Fahrzeugkauf of a Vorgang.
updateFinanzierungswunsch ( vorgangsnummer: String!, finanzierungswunsch: Finanzierungswunsch ! ) -> BasicResponse !
This mutation is for updating the Finanzierungswunsch of a Vorgang.
Finanzierungswunsch.rateMonatlich
is only processed, if the field laufzeitInMonaten
is not set.Finanzierungswunsch.ratenzahlungstermin
is not specified, the default value MONATSENDE
is used.POST https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
Authorization: Bearer xxxx
Content-Type: application/json
{
"query": "mutation finanzierungswunsch($vorgangsnummer: String!) {
updateFinanzierungswunsch(vorgangsnummer: $vorgangsnummer, finanzierungswunsch: { kreditbetrag: 10000 }){
messages
}
}",
"variables": {
"vorgangsnummer": "ABC123"
}
}
{
"data": {
"messages": []
},
"errors": []
}
updateFinanzierungszweck ( vorgangsnummer: String!, finanzierungszweck: Finanzierungszweck !)
This mutation is for updating the Finanzierungszweck of a Vorgang.
FAHRZEUGKAUF
if the Vorgang has a position which should be refinanced, meaning abloesen
is true. Relevant positions are SonstigeVerbindlichkeit
, Kreditkarte
, Ratenkredit
and Dispositionskredit
.updateRatenschutz ( vorgangsnummer: String!, antragstellerId: String!, ratenschutz: Ratenschutz ! ) -> BasicResponse !
This mutation is for updating the Ratenschutz for an Antragsteller of a Vorgang.
antragstellerId
has to refer to an existing Antragsteller in the Vorgang.createAccountCheckSession ( vorgangsnummer: String! ) -> AccountCheckSessionResponse !
This mutation creates a session for the digital account check provider tink . It returns a session key that can be used in their account check wizard.
AKTIV
, which means it must not be archived.addKommentare ( vorgangsnummer: String!, kommentare: [String!]! ) -> BasicResponse !
This mutation is for adding one or more Kommentare to a Vorgang.
AKTIV
, which means it must not be archived.POST https://kex-vorgaenge.ratenkredit.api.europace.de/vorgaenge
Authorization: Bearer xxxx
Content-Type: application/json
{
"query": "mutation kommentare($vorgangsnummer: String!) {
addKommentare(vorgangsnummer: $vorgangsnummer, kommentare: ["kommentar 1", "kommentar 2"]){
messages
}
}",
"variables": {
"vorgangsnummer": "ABC123"
}
}
{
"data": {
"messages": []
},
"errors": []
}
updateBearbeiter ( vorgangsnummer: String!, partnerId: String! ) -> BasicResponse !
AKTIV
, which means it must not be archived.updateKundenbetreuer ( vorgangsnummer: String!, partnerId: String! ) -> BasicResponse !
AKTIV
, which means it must not be archived.{
"herkunft": Herkunft,
"personendaten": Personendaten,
"wohnsituation": Wohnsituation,
"beschaeftigung": Beschaeftigung
}
{
"beschaeftigungsart": "ANGESTELLTER" | "ARBEITER" | "ARBEITSLOSER" | "BEAMTER" | "FREIBERUFLER" | "HAUSFRAU" | "RENTNER" | "SELBSTSTAENDIGER",
"angestellter": Angestellter,
"arbeiter": Arbeiter,
"arbeitsloser": Arbeitsloser,
"beamter": Beamter,
"freiberufler": Freiberufler,
"hausfrau": Hausfrau,
"rentner": Rentner,
"selbststaendiger": Selbstständiger
}
The beschaeftigungsart
determines which data is used. For example the beschaeftigungsart=ARBEITER
means that all data of field arbeiter
is used, for beschaeftigungsart=BEAMTER
the data of
field beamter
is used. All other fields will be ignored. If there is no value for beschaeftigungsart
or the corresponding field to a beschaeftigungsart
is empty, all data is ignored.
{
"beschaeftigungsverhaeltnis": {
"arbeitgeber": Firma,
"berufsbezeichnung": String,
"befristung": "BEFRISTET" | "UNBEFRISTET",
"befristetBis": "YYYY-MM-DD",
"beschaeftigtSeit": "YYYY-MM-DD",
"inProbezeit": true | false,
"nettoeinkommenMonatlich": BigDecimal
},
"vorherigesBeschaeftigungsverhaeltnis": {
"arbeitgeber": Firma,
"beschaeftigtSeit": "YYYY-MM-DD",
"beschaeftigtBis": "YYYY-MM-DD"
}
}
{
"beschaeftigungsverhaeltnis": {
"arbeitgeber": Firma,
"berufsbezeichnung": String,
"befristung": "BEFRISTET" | "UNBEFRISTET",
"befristetBis": "YYYY-MM-DD",
"beschaeftigtSeit": "YYYY-MM-DD",
"inProbezeit": true | false,
"nettoeinkommenMonatlich": BigDecimal
},
"vorherigesBeschaeftigungsverhaeltnis": {
"arbeitgeber": Firma,
"beschaeftigtSeit": "YYYY-MM-DD",
"beschaeftigtBis": "YYYY-MM-DD"
}
}
{
"sonstigesEinkommenMonatlich": BigDecimal
}
{
"beschaeftigungsverhaeltnis": {
"arbeitgeber": Firma,
"berufsbezeichnung": String,
"beschaeftigtSeit": "YYYY-MM-DD",
"inProbezeit": true | false,
"nettoeinkommenMonatlich": BigDecimal,
"verbeamtetSeit": "YYYY-MM-DD"
},
"vorherigesBeschaeftigungsverhaeltnis": {
"arbeitgeber": Firma,
"beschaeftigtSeit": "YYYY-MM-DD",
"beschaeftigtBis": "YYYY-MM-DD"
}
}
{
"berufsbezeichnung": String,
"firma": Firma,
"selbststaendigSeit": "YYYY-MM-DD",
"nettoeinkommenJaehrlich": BigDecimal,
"bruttoEinkommenLaufendesJahr": BigDecimal,
"einkommenssteuerLaufendesJahr": BigDecimal,
"abschreibungenLaufendesJahr": BigDecimal,
"bruttoEinkommenLetztesJahr": BigDecimal,
"einkommenssteuerLetztesJahr": BigDecimal,
"abschreibungenLetztesJahr": BigDecimal,
"einkommenssteuerVor2Jahren": BigDecimal,
"bruttoEinkommenVor2Jahren": BigDecimal,
"abschreibungenVor2Jahren": BigDecimal,
"bruttoEinkommenVor3Jahren": BigDecimal,
"einkommenssteuerVor3Jahren": BigDecimal,
"abschreibungenVor3Jahren": BigDecimal
}
{
"sonstigesEinkommenMonatlich": BigDecimal
}
{
"rentenversicherung": {
"name": String,
"anschrift": Anschrift
},
"rentnerSeit": "YYYY-MM-DD",
"staatlicheRenteMonatlich": BigDecimal
}
{
"berufsbezeichnung": String,
"firma": Firma,
"selbststaendigSeit": "YYYY-MM-DD",
"nettoeinkommenJaehrlich": BigDecimal,
"bruttoEinkommenLaufendesJahr": BigDecimal,
"einkommenssteuerLaufendesJahr": BigDecimal,
"abschreibungenLaufendesJahr": BigDecimal,
"bruttoEinkommenLetztesJahr": BigDecimal,
"einkommenssteuerLetztesJahr": BigDecimal,
"abschreibungenLetztesJahr": BigDecimal,
"einkommenssteuerVor2Jahren": BigDecimal,
"bruttoEinkommenVor2Jahren": BigDecimal,
"abschreibungenVor2Jahren": BigDecimal,
"bruttoEinkommenVor3Jahren": BigDecimal,
"einkommenssteuerVor3Jahren": BigDecimal,
"abschreibungenVor3Jahren": BigDecimal
}
{
"strasse": String,
"hausnummer": String,
"plz": String,
"ort": String,
"land": Country
}
This Type uses the format ISO-3166/ALPHA-2
In addition there is the value “SONSTIGE” (“other”)
"AD" | "AE" | "AF" | "AG" | "AL" | "AM" | "AO" | "AR" | "AT" | "AU" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BN" | "BO" | "BR" | "BS" | "BT" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "XK" | "CU" | "CV" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FM" | "FR" | "GA" | "GB" | "GD" | "GE" | "GH" | "GM" | "GN" | "GQ" | "GR" | "GT" | "GW" | "GY" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IN" | "IQ" | "IR" | "IS" | "IT" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MR" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PG" | "PH" | "PK" | "PL" | "PS" | "PT" | "PW" | "PY" | "QA" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SI" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SY" | "SZ" | "TD" | "TG" | "TH" | "TJ" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VN" | "VU" | "WS" | "YE" | "ZA" | "ZM" | "ZW" | "SONSTIGE"
{
"anschrift": Anschrift,
"branche": "LANDWIRTSCHAFT_FORSTWIRTSCHAFT_FISCHEREI" | "ENERGIE_WASSERVERSORGUNG_BERGBAU" | "VERARBEITENDES_GEWERBE" | "BAUGEWERBE" | "HANDEL" | "VERKEHR_LOGISTIK" | "INFORMATION_KOMMUNIKATION" | "GEMEINNUETZIGE_ORGANISATION" | "KREDITINSTITUTE_VERSICHERUNGEN" | "PRIVATE_HAUSHALTE" | "DIENSTLEISTUNGEN" | "OEFFENTLICHER_DIENST" | "GEBIETSKOERPERSCHAFTEN" | "HOTEL_GASTRONOMIE" | "ERZIEHUNG_UNTERRICHT" | "KULTUR_SPORT_UNTERHALTUNG" | "GESUNDHEIT_SOZIALWESEN",
"name": String
}
{
"antragstellerIds": [ String ],
"sparbeitragMonatlich": BigDecimal
}
{
"abloesen": Boolean,
"antragstellerIds": [String],
"beanspruchterBetrag": BigDecimal,
"bic": String,
"glaeubiger": String,
"iban": String,
"verfuegungsrahmen": BigDecimal,
"zinssatz": BigDecimal,
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"antragstellerIds": [ String ],
"beginnDerTaetigkeit": "YYYY-MM-DD",
"betragMonatlich": BigDecimal
}
{
"modell": String,
"marke": String,
"kaufpreis": BigDecimal,
"erstzulassungsdatum": "YYYY-MM-DD",
"laufleistung": Integer,
"kw": Integer,
"beglicheneKosten": BigDecimal,
"ps": Integer,
"anbieter": "HAENDLER" | "PRIVAT"
}
{
"kreditbetrag": BigDecimal,
"laufzeitInMonaten": Integer,
"provisionswunschInProzent": BigDecimal,
"rateMonatlich": BigDecimal,
"ratenzahlungstermin": Ratenzahlungstermin
}
"MONATSENDE" | "MONATSMITTE"
"UMSCHULDUNG" | "FAHRZEUGKAUF" | "MODERNISIERUNG" | "FREIE_VERWENDUNG"
{
"arbeitserlaubnisVorhanden": true | false,
"arbeitserlaubnisBefristetBis": "YYYY-MM-DD",
"aufenthaltstitel": "VISUM" | "AUFENTHALTSERLAUBNIS" | "NIEDERLASSUNGSERLAUBNIS" | "ERLAUBNIS_ZUM_DAUERAUFENTHALT_EU",
"aufenthaltBefristetBis": "YYYY-MM-DD",
"inDeutschlandSeit": "YYYY-MM-DD",
"staatsangehoerigkeit": Country,
"steuerId": String
}
{
"antragstellerIds": [ String ],
"bezeichnung": String,
"darlehen": [
{
"restschuld": BigDecimal,
"zinsbindungBis": "YYYY-MM-DD",
"rateMonatlich": BigDecimal
}
],
"immobilienart": "EIGENTUMSWOHNUNG" | "EINFAMILIENHAUS" | "MEHRFAMILIENHAUS" | "BUEROGEBAEUDE",
"mieteinnahmenKaltMonatlich": BigDecimal,
"mieteinnahmenWarmMonatlich": BigDecimal,
"nebenkostenMonatlich": BigDecimal,
"nutzungsart": "EIGENGENUTZT" | "VERMIETET" | "EIGENGENUTZT_UND_VERMIETET",
"vermieteteWohnflaeche": Integer,
"wert": BigDecimal,
"wohnflaeche": Integer
}
{
"antragstellerIds": [ String ],
"kindergeldFuer": "ERSTES_ODER_ZWEITES_KIND" | "DRITTES_KIND" | "AB_VIERTEM_KIND",
"name": String,
"unterhaltseinnahmenMonatlich": BigDecimal
}
{
"antragstellerIds": [ String ],
"bic": String,
"iban": String
}
{
"abloesen": Boolean,
"antragstellerIds: [String],
"beanspruchterBetrag": BigDecimal,
"bic": String,
"glaeubiger": String,
"iban": String,
"rateMonatlich": BigDeciaml,
"verfuegungsrahmen": BigDecimal,
"zinssatz": BigDecimal
}
{
"antragstellerIds": [ String ],
"datumLetzteRate": LocalDate,
"glaeubiger": String,
"rateMonatlich": BigDecimal,
"schlussrate": BigDecimal
}
{
"antragstellerIds": [ String ],
"praemieMonatlich": BigDecimal
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"anrede": "FRAU" | "HERR",
"email": String,
"familienstand": "LEDIG" | "VERHEIRATET" | "GESCHIEDEN" | "VERWITWET" | "GETRENNT_LEBEND" | "EHEAEHNLICHE_LEBENSGEMEINSCHAFT" | "EINGETRAGENE_LEBENSPARTNERSCHAFT",
"geburtsdatum": "YYYY-MM-DD",
"geburtsland": Country,
"geburtsname": String,
"geburtsort": String,
"nachname": String,
"telefonGeschaeftlich": String,
"telefonPrivat": String,
"titel": [ "DOKTOR" | "PROFESSOR" ],
"vorname": String
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"abloesen": Boolean,
"antragstellerIds": [ String ],
"bic": String,
"datumErsteZahlung": LocalDate,
"datumLetzteRate": LocalDate,
"glaeubiger": String,
"iban": String,
"rateMonatlich": BigDecimal,
"restschuld": BigDecimal,
"schlussrate": BigDeciaml,
"urspruenglicherKreditbetrag": BigDecimal
}
{
"arbeitslosigkeitAbsicherung": RatenschutzAbsicherung,
"arbeitsunfaehigkeitAbsicherung": RatenschutzAbsicherung,
"todesfallAbsicherung": RatenschutzAbsicherung
}
{
"gewuenscht": Boolean,
"kommentar": String,
"vorhanden": Boolean,
"wichtig": Boolean
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"abloesen": Boolean,
"antragstellerIds": [ String ],
"bic": String,
"datumErsteZahlung": LocalDate,
"datumLetzteRate": LocalDate,
"glaeubiger": String,
"iban": String,
"rateMonatlich": BigDecimal,
"restschuld": BigDecimal,
"schlussrate": BigDeciaml,
"urspruenglicherKreditbetrag": BigDecimal
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"antragstellerIds": [ String ],
"betragMonatlich": BigDecimal
}
{
"anschrift": Wohnanschrift,
"anzahlPersonenImHaushalt": Integer,
"anzahlPkw": Integer,
"gemeinsamerHaushalt": true | false,
"voranschrift": Wohnanschrift,
"wohnart": "ZUR_MIETE" | "ZUR_UNTERMIETE" | "IM_EIGENEN_HAUS" | "BEI_DEN_ELTERN"
}
{
"strasse": String,
"hausnummer": String,
"plz": String,
"ort": String,
"land": Country,
"wohnhaftSeit": "YYYY-MM-DD"
}
If we do server-side adaptions of the data to ensure a valid dataset, we add hints to the
messages
field of the response. These are purely to inform the client, there are NEVER any errors in themessages
field. Errors will be only shown in theerrors
field of the response.
{
"messages" [ String ]
}
{
"messages": [ String ]
"id": String
}
{
"wizardSessionKey": String
}
The APIs are made available under the following Terms of Use .