REST-API

Für alles, was du selbst bauen willst.

Kunden, Verträge und die Lebenslage — lesbar und schreibbar über eine dokumentierte Schnittstelle. OAuth2, JSON, feingranulare Rechte.

Beraterzugang Free · Dauerhaft 0,00 € · Ohne Kreditkarte

Wie es aussieht

Ein Aufruf, eine Antwort.

Lebenslage eines Kunden abrufen

GET /v1/client/financial-profile/8fa21c
Authorization: Bearer <OAuth2-Token>

{
  "relationshipStatus": "married",
  "professionStatus": "employed",
  "childrenAmount": 1,
  "housingSituation": "rented",
  "provisionTargets": [ "retirement" ],
  "completed": true
}

Woraus Vinlivt rechnet

Die Lebenslage auf der einen Seite, die Verträge auf der anderen. Aus der Differenz entsteht alles, was der Beraterzugang zeigt — und beides kannst du über die Schnittstelle lesen und schreiben.

Basis
https://api.vinlivt.cloud
Version
v1
Format
JSON, UTF-8
Zur API-Dokumentation

Die Endpunkte

Vier Bereiche, in beide Richtungen.

Kunden und Verträge lesend und schreibend, die Lebenslage lesend, dazu Berater und Stammdaten. Hier stehen fünfzehn der neunzehn Wege — die vollständige Liste mit allen Feldern steht in der Dokumentation.

Kundenclient:read · client:write

  • GET/v1/clientAlle Kunden auflisten
  • POST/v1/clientKunden anlegen
  • GET/v1/client/{clientId}Einzelnen Kunden lesen
  • PUT/v1/client/{clientId}Kundendaten ändern
  • GET/v1/client/financial-profile/{clientId}Lebenslage abrufen — die Grundlage der Analyse
  • PUT/v1/client/{clientId}/external-mandateFremdmandat setzen

Verträgecontract:read · contract:write

  • GET/v1/contractsAlle Verträge des Beraters
  • POST/v1/contractsVertrag anlegen
  • GET/v1/contracts/{clientId}Verträge eines Kunden
  • PUT/v1/contracts/{clientId}/{contractUid}Vertrag ändern

Berateradvisor:read

  • GET/v1/meEigene Beraterdaten
  • GET/v1/advisor/visibleSichtbare Berater im Haus
  • PUT/v1/client/{clientId}/main-advisor/{advisorId}Betreuung umhängen

Stammdatenopenid

  • GET/v1/insurance-providersVersicherungsgesellschaften
  • GET/v1/insurance-typesVersicherungstypen

Anmeldung

OAuth2, mit Rechten, die du zuschneidest.

Authorization-Code-Flow gegen den Vinlivt-Identitätsdienst. Du fragst nur die Rechte an, die deine Anwendung tatsächlich braucht — ein Werkzeug, das nur liest, bekommt auch nur Leserechte.

  • client:readKunden und ihre Lebenslage lesen
  • client:writeKunden anlegen, ändern, Betreuung umhängen
  • contract:readVerträge lesen
  • contract:writeVerträge anlegen und ändern
  • advisor:readBeraterdaten lesen
  • openidAnmeldung und Stammdaten

Zugangsdaten und die freigegebenen Rechte klären wir im Zugang. Maßgeblich sind Spezifikation und Dokumentation, nicht diese Seite.

Zugang anlegen, Schlüssel holen, loslegen.

Der Beraterzugang Free kostet dauerhaft nichts — die Schnittstelle ist darin enthalten.

Kein Vertriebsanruf · Ohne Kreditkarte · Keine Provisionsabgabe · Dauerhaft 0,00 €