Vorgang Import API

Vorgang Import API

Beschreibung

Die Vorgang API dient zum Überleiten von Partner-, Tippgeber und Vorgangsdaten. Hier finden Sie die Nutzungsbedingungen.

Vorgang importieren

Die Schnittstelle zum Vorgang importieren basiert auf dem Import von Daten der Schnittstelle von Europace. Das Format und die Struktur wurden für die Vorgangsdaten übernommen und um Partner-, Tippgeber- und Customdaten, sowie individuelle Kommentaren ergänzt.

Ein neuer Vorgang wird per HTTP POST angelegt.

Stage Url
production https://api.drkleinservice.de/vorgang
development https://testapi.drkleinservice.de/vorgang

Die Daten werden als JSON Dokument im Body des POST Requests übermittelt. Ein erfolgreicher Aufruf resultiert in einer Response mit dem HTTP Statuscode 201 CREATED.

Authentifizierung und Autorisierung

Die Authentifizierung erfolgt über OAuth2.

Vorgang

Vorgang Daten

Wert Referenz zur Europace Dokumentation
leadquelle Leadquelle
antragsteller1 Antragsteller
antragsteller2 Antragsteller
haushalt Haushalt
finanzbedarf Finanzbedarf
kommentare kommentare

Tippgeber Daten (tippgeber)

Wert Datentyp Beschreibung
externeMitarbeiternummer String Die Mitarbeiternummer des Tippgebers.
vorname String Der Vorname des Tippgebers.
nachname String Der Nachname des Tippgebers.
anrede String Die Anrede des Tippgebers. Werte sind HERR oder FRAU.
telefon String Die Telefonnummer des Tippgebers.
email String Die Email des Tippgebers.

Partner Daten (partner)

Wert Datentyp Beschreibung
custom Object Benutzerdefinierte Werte, die nicht in dem Standard dieser Schnittstelle enthalten sind.

Custom Daten (custom)

Wert Datentyp Beschreibung
key String Der Name vom key.
value various types Das value kann den Datentyp boolean, number, Date (ISO 8601), string haben.

Pflichtfelder

Wert Datentyp Beschreibung
vorgang.leadquelle String Bezeichnung des Leadgebers.
vorgang.antragsteller1.personendaten.geburtsdatum String Das Geburtsdatum von antragsteller1.
vorgang.antragsteller1.personendaten.email String Die E-Mail von antragsteller1.
vorgang.antragsteller2.personendaten.geburtsdatum String Das Geburtsdatum von antragsteller2.
vorgang.antragsteller2.personendaten.email String Die E-Mail von antragsteller2.
tippgeber.email String Die E-Mail des Tippgebers.
tippgeber.externeMitarbeiternummer String Die Mitarbeiternummer des Tippgebers.

API-Dokumentation: Ablehnungsgründe

Dieser API-Abschnitt beschreibt verschiedene Ablehnungsgründe für Anträge basierend auf spezifischen Kriterien wie Beschäftigung, Einkommen, Postleitzahl und finanziellen Einschränkungen. Diese Feature ist momentan nur aktiv für ein Kooperationspartner.

Eine Ablehnung wird durch den rejectionReason-Wert in der Response angezeigt z.B {code: "GR001", message: "Ablehnung aufgrund unsicherer Beschäftigungssituation des ersten Antragstellers"}

Der erste definierte Ablehnungsgrund wird in der folgenden Reihenfolge zurückgegeben: GR001, GR002, GR003, GR004, GR005, GR006.

Wenn in der eingehenden Anfrage keine Ablehnungsgründe identifiziert werden, wird das Feld rejectionReason nicht zurückgegeben.

Mögliche Ablehnungsgründe

Ablehnungsgründe: Code und Nachricht

Code Nachricht
GR001 Ablehnung aufgrund unsicherer Beschäftigungssituation des ersten Antragstellers
GR002 Ablehnung aufgrund unsicherer Beschäftigungssituation beider Antragsteller
GR003 Ablehnung aufgrund ungültiger Postleitzahl des ersten Antragstellers
GR004 Ablehnung aufgrund unzureichendem Gesamteinkommen des ersten Antragstellers
GR005 Ablehnung aufgrund unzureichendem Gesamteinkommen des ersten Antragstellers
GR006 Ablehnung aufgrund von finanzieller Einschränkung

Ablehnungsgründe: Code und Bedingungen

Code Bedingungen
GR001 Beschäftigungsart des ersten Antragstellers enthält [“ARBEITSLOSER”, “FREIBERUFLER”, “HAUSFRAU”, “SELBSTSTAENDIGER”]
GR002 Beschäftigungsart des ersten Antragstellers und des zweiten Antragstellers enthält [“ARBEITSLOSER”, “FREIBERUFLER”, “HAUSFRAU”, “SELBSTSTAENDIGER”]
GR003 antragsteller1.wohnsituation.anschrift.plz ist nicht 5-stellig
GR004 Die Summe aus vorgang?.haushalt?.kinder[index].unterhaltseinnahmenMonatlich und antragsteller1?.beschaeftigung?.[beschaeftigungsart]?.beschaeftigungsverhaeltnis?.nettoeinkommenMonatlich beträgt weniger als 750 €
GR005 Die Summe aus vorgang?.haushalt?.kinder[index].unterhaltseinnahmenMonatlich und antragsteller1?.beschaeftigung?.rentner?.staatlicheRenteMonatlich beträgt weniger als 750 €
GR006 Eine Ablehnung erfolgt nur, wenn einer der Schlüssel im JSON-Objekt von partner.custom.finanzielleEinschraenkungen den Wert true hat. Das JSON-Objekt besteht aus den folgenden Schlüsseln: “S1_ZPO_ABGEGEBENE_VERMOEGENSAUSKUNFT” “HAFTBEFEHL” “ERLEDIGT_RESTSCHULD_UEBER_5000_EURO” “OFFENE_RESTSCHULD_UEBER_1000_EURO” Wenn mindestens einer dieser Schlüssel den Wert true aufweist, wird die Anfrage abgelehnt.

Beispiel

Request

Request-Header Name: Authentication
Request Header Value: Bearer {jwt}

Request-Header Name: content-type
Request Header Value: application/json

POST
https://api.drkleinservice.de/vorgang

{
  "vorgang": {
    "leadquelle": "Bank im Ventil",
    "antragsteller1": {
      "personendaten": {
        "vorname": "Max",
        "nachname": "Mustermann"
      },
      "wohnsituation": {
        "anschrift": {
          "strasse": "Musterstraße.",
          "hausnummer": "41a",
          "plz": "10713",
          "ort": "Berlin",
          "wohnhaftSeit": "2016-01-01"
        },
        "anzahlPersonenImHaushalt": 1,
        "wohnart": "ZUR_MIETE"
      }
    },
    "haushalt": {
      "kontoverbindung": {
        "iban": "DE98600100700160451700",
        "gehoertZuAntragsteller": "ANTRAGSTELLER_1"
      },
      "ausgaben": {
        "privateKrankenversicherungen": [
          {
            "betragMonatlich": 200.01,
            "gehoertZuAntragsteller": "ANTRAGSTELLER_1"
          }
        ],
        "mietausgaben": [
          {
            "betragMonatlich": 200.01,
            "gehoertZuAntragsteller": "ANTRAGSTELLER_1"
          }
        ]
      }
    },
    "finanzbedarf": {
      "finanzierungszweck": "FREIE_VERWENDUNG",
      "finanzierungswunsch": {
        "kreditbetrag": 10000,
        "laufzeitInMonaten": 24,
        "ratenzahlungstermin": "MONATSENDE"
      }
    },
    "kommentare": ["Max Mustermann hat 3 Kreditkarten."]
  },
  "tippgeber": {
    "externeMitarbeiternummer": "078181726-121",
    "vorname": "Max",
    "nachname": "Mustermann",
    "anrede": "HERR",
    "telefon": "0612-298-xxxx",
    "email": "max.mustermann@partner.de"
  },
  "partner": {
    "custom": {
      "telefonTermin": "2021-01-10 13:00:00",
      "filialId": "123123",
      "kundennummer": "143251ab",
      "vertriebsschluessel": "KOOPERATION_MIT_DRKLEIN"
    }
  }
}

In Abhängigkeit der leadquelle wird der Vorgang nach Europace weitergeleitet und wir geben die europaceVorgangsnummer zurück.

Response

Antwort Felder

Wert Datentyp Beschreibung
europaceVorgangsnummer String Vorgangsnummer von Kreditsmart zum neuen Vorgang.
rejectionReason Object Ablehnungsgrund
messages [String] Hinweise zum Import des Vorgangs. 
{
  "europaceVorgangsnummer": "AB1234",
  "rejectionReason": {code: "GR004", message: "Ablehnung aufgrund unzureichendem Gesamteinkommen des ersten Antragstellers"}
  "messages": []
}

Die Daten zu Antragsteller, Haushalt und Finanzierungsbedarf werden über die von Europace bereitgestellte API KEX-Import API an Kreditsmart übergeben. Die Daten zum Tippgeber werden für die Partnererstellung im Partnermanagment verwendet. Die Daten zu den Kommentaren, um in der Ereignislasche von Kreditsmart den Finanzierungsberater weitere Informationen anzuzeigen.

Begriffserklärung

Begriff Beschreibung
Kreditsmart Frontend für die Kreditberatung.
Kreditsmart-Ereignislasche Frontend Bereich in dem Kommentare angezeigt werden.
Partnermanagement Benutzerverwaltung von Europace.
Back to homepage