Vorgang Update API

Vorgang Import API

Beschreibung

Die Vorgang Update API ermöglicht das Aktualisieren eines Vorgangs. Hier finden Sie die Nutzungsbedingungen.

Vorgang aktualisieren

Die Schnittstelle zum Vorgang aktualisieren basiert auf dem Import von Daten der Vorgang Import Api. Ein bestehender Vorgang kann per HTTP PUT und der vorgangsnummer aktualisiert werden.

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

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

Authentifizierung und Autorisierung

Die Authentifizierung erfolgt über OAuth2.

Informationen

Bei der Aktualisierung eines Vorgangs muss erneut der komplette Datensatz für folgende Bereiche übermittelt werden.

  • Haushalt
    • Kinder
    • Immobilien
    • alle Bonitätsanagben
  • Ratenschutz
    • Versicherte Rsikien

Andere Bereiche, wie der Bereich des antragsteller kann nur durch ein Subset aktualisiert werden.

Was kann nicht aktualisiert werden?

  • Partner
  • Tippgeber
  • Leadquelle

Die Vorgang Update API ist beschränkt auf Dr. Klein RK Vorgangsnummern.

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/{1234567}

{
  "vorgang": {
    "leadquelle": "DIGITALER_ABSCHLUSS",
    "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."]
  }
}

Response

{
  "vorgangsnummer": "1234567",
  "messages": []
}
Wert Datentyp Beschreibung
vorgangsnummer String Vorgangsnummer von Dr. Klein RK GmbH zum neuen Vorgang.
messages [String] Hinweise zum Import des Vorgangs.
Back to homepage