• Arbeitskraftsicherung
  • Altersvorsorge
  • betriebliche Altersvorsorge
  • Beihilfe
  • Bauherrenhaftpflicht
  • Berufsunfähigkeit
  • Erwerbsunfähigkeit
  • Einzeltarifberechnung
  • Gewässerschadenhaftpflicht
  • Hausrat
  • Haus und Grund
  • Tierhalterhaftpflicht - Hund
  • KFZ
  • Kinderprodukte
  • klv
  • Krankenversicherung
  • Krankenzusatzversicherung
  • Tierhalterhaftpflicht - Pferd
  • Privathaftpflicht
  • Pflegerente
  • Pflegetagegeld
  • Risikoleben
  • Rechtsschutz
  • Sterbegeld
  • Unfall
  • Wohngebäude

    • Übersicht

    Toolnutzung

    Toolnutzung: Prämienberechnung

    Toolnutzung: Dokumentenerstellung

    funds/getcatalogue

    Ermöglicht das Abrufen eines Fondskatalogs

    Request

    Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/funds/getcatalogue

    Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/funds/getcatalogue/request/schema

    Validation: POST https://bankathon.fb-xpert.fb-preview.de/external/funds/getcatalogue/validate


    property default description options
    [ token ] * required
    string
    Ein gültiger Token für die Authentifizierung mit der Schnittstelle.
    [ tarif_id ] * required
    string
    Tarif ID für welche die Fonds abgerufen werden sollen
    example:

    mime-type: application/json, text/json

    {
    "token": "a1s2d3f4g5h6j7k8l9",
    "tarif_id": "123456"
}
    example:

    mime-type: application/json, text/json

    {
    "token": "a1s2d3f4g5h6j7k8l9",
    "tarif_id": "123456"
}

    Response

    Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/funds/getcatalogue/response/schema


    property description options
    [ status ] * required
    string
    Status des Aufrufs
    OK: Anfrage erfolgreich
    ERROR: Anfrage verlief fehlerhaft
    [ errors ]
    string[]
    Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!
    * required
    array
    Grundlegende Steuerungen für die einzelnen Fondtypen
    property description options
    properties[ type ] * required
    enumeration
    Beschreibt den Typen der Anlageoption
    Value Label
    INDIVIDUELL INDIVIDUELL
    WERTSICHERUNG WERTSICHERUNG
    INDEX INDEX
    PORTFOLIO PORTFOLIO
    STRATEGIE STRATEGIE
    properties[ min_selections ] * required
    int
    Minimale Anzahl der zu selektierenden Fonds
    properties[ max_selections ] * required
    int
    Maximale Anzahl der zu selektierenden Fonds
    properties[ min_percentage_fonds ] * required
    int
    Minimalwert für die prozentuale Verteilung
    properties[ max_percentage_fonds ] * required
    int
    Maximalwert für die prozentuale Verteilung
    [ combinations ] * required
    array
    Gibt an, welche "type"´s miteinander kombiniert werden können. Alle nicht aufgeführten "type"´s können nicht ausgewählt werden!
    Erläuterung des "examples":
    (INDIVIDUELL und WERTSICHERUNG) oder (PORTFOLIO und WERTSICHERUNG)
    * required
    array
    Daten aus dem Fondskatalog des gewählten Tarifs

    anyOf: Mehrere verschiedene Subschemas können angegeben werden

    property description options
    funds[ tarif_id ] * required
    string
    Zuordnung zur Tarif ID
    funds[ type ] * required
    enumeration
    Beschreibt den Typen der Anlageoption
    Value Label
    INDIVIDUELL Freie Fondsauswahl
    funds[ isin ] * required
    string
    ISIN der Anlageoption
    funds[ company_fond_id ]
    string
    interne ID zur Identifizierung der Anlageoption im Webservice des Versicherers
    funds[ percent ]
    float
    min: 0 max: 100 
    Beschreibt zu wie viel Prozent die gewählte Anlageoption in die Tarifberechnung einfließen soll.
    funds[ name ] * required
    string
    Name der Anlageoption
    funds[ company_name ] * required
    string
    Fondsgesellschaft
    funds[ category_name ] * required
    string
    Fondskategorie
    funds[ recommendation ] * required
    bool
    Gibt an ob es sich bei der Anlageoption um eine Empfehlung handelt
    * required
    object
    Gibt ausgewählte Charakterisierungen für den Fonds an
    property description options
    characteristics[ is_etf ] * required
    bool
    Beschreibt ob der Fonds ein ETF Fonds ist.
    characteristics[ esg_article ] * required
    int
    Beschreibt wie mit den Nachhaltigkeitsrisiken umgegangen wird.
    property description options
    funds[ tarif_id ] * required
    string
    Zuordnung zur Tarif ID
    funds[ type ] * required
    enumeration
    Beschreibt den Typen der Anlageoption
    Value Label
    WERTSICHERUNG Wertsicherungsfonds / zweiter Anlagetopf
    funds[ isin ] * required
    string
    ISIN der Anlageoption
    funds[ company_fond_id ]
    string
    interne ID zur Identifizierung der Anlageoption im Webservice des Versicherers
    funds[ percent ]
    float
    min: 0 max: 100 
    Beschreibt zu wie viel Prozent die gewählte Anlageoption in die Tarifberechnung einfließen soll.
    funds[ name ] * required
    string
    Name der Anlageoption
    funds[ company_name ] * required
    string
    Fondsgesellschaft
    funds[ category_name ] * required
    string
    Fondskategorie
    funds[ recommendation ] * required
    bool
    Gibt an ob es sich bei der Anlageoption um eine Empfehlung handelt
    * required
    object
    Gibt ausgewählte Charakterisierungen für den Fonds an
    property description options
    characteristics[ is_etf ] * required
    bool
    Beschreibt ob der Fonds ein ETF Fonds ist.
    characteristics[ esg_article ] * required
    int
    Beschreibt wie mit den Nachhaltigkeitsrisiken umgegangen wird.
    property description options
    funds[ tarif_id ] * required
    string
    Zuordnung zur Tarif ID
    funds[ type ] * required
    enumeration
    Beschreibt den Typen der Anlageoption
    Value Label
    INDEX Index
    funds[ capitalinvestment_id ] * required
    int
    ID des jeweiligen Kapitalanlageprodukt

    array
    Liste der im Kapitalanlageprodukt enthaltenen Fonds
    property description options
    capitalinvestment_isins[ id ] * required
    string
    interne ID
    capitalinvestment_isins[ isin ] * required
    string
    ISIN der Anlageoption
    capitalinvestment_isins[ percent ]
    float
    min: 0 max: 100 
    Beschreibt die prozentuale anzeil der ISIN im gewählte Anlageoption.
    funds[ company_fond_id ]
    string
    interne ID zur Identifizierung der Anlageoption im Webservice des Versicherers
    funds[ percent ]
    float
    min: 0 max: 100 
    Beschreibt zu wie viel Prozent die gewählte Anlageoption in die Tarifberechnung einfließen soll.
    funds[ name ] * required
    string
    Name der Anlageoption
    funds[ recommendation ] * required
    bool
    Gibt an ob es sich bei der Anlageoption um eine Empfehlung handelt
    property description options
    funds[ tarif_id ] * required
    string
    Zuordnung zur Tarif ID
    funds[ type ] * required
    enumeration
    Beschreibt den Typen der Anlageoption
    Value Label
    PORTFOLIO Portfolio
    funds[ capitalinvestment_id ] * required
    int
    ID des jeweiligen Kapitalanlageprodukt

    array
    Liste der im Kapitalanlageprodukt enthaltenen Fonds
    property description options
    capitalinvestment_isins[ id ] * required
    string
    interne ID
    capitalinvestment_isins[ isin ] * required
    string
    ISIN der Anlageoption
    capitalinvestment_isins[ percent ]
    float
    min: 0 max: 100 
    Beschreibt die prozentuale anzeil der ISIN im gewählte Anlageoption.
    funds[ company_fond_id ]
    string
    interne ID zur Identifizierung der Anlageoption im Webservice des Versicherers
    funds[ percent ]
    float
    min: 0 max: 100 
    Beschreibt zu wie viel Prozent die gewählte Anlageoption in die Tarifberechnung einfließen soll.
    funds[ name ] * required
    string
    Name der Anlageoption
    funds[ recommendation ] * required
    bool
    Gibt an ob es sich bei der Anlageoption um eine Empfehlung handelt
    property description options
    funds[ tarif_id ] * required
    string
    Zuordnung zur Tarif ID
    funds[ type ] * required
    enumeration
    Beschreibt den Typen der Anlageoption
    Value Label
    SICHERUNGSVERMOEGEN Sicherungsvermögen
    funds[ capitalinvestment_id ] * required
    int
    ID des jeweiligen Kapitalanlageprodukt

    array
    Liste der im Kapitalanlageprodukt enthaltenen Fonds
    property description options
    capitalinvestment_isins[ id ] * required
    string
    interne ID
    capitalinvestment_isins[ isin ] * required
    string
    ISIN der Anlageoption
    capitalinvestment_isins[ percent ]
    float
    min: 0 max: 100 
    Beschreibt die prozentuale anzeil der ISIN im gewählte Anlageoption.
    funds[ company_fond_id ]
    string
    interne ID zur Identifizierung der Anlageoption im Webservice des Versicherers
    funds[ percent ]
    float
    min: 0 max: 100 
    Beschreibt zu wie viel Prozent die gewählte Anlageoption in die Tarifberechnung einfließen soll.
    funds[ name ] * required
    string
    Name der Anlageoption
    funds[ recommendation ] * required
    bool
    Gibt an ob es sich bei der Anlageoption um eine Empfehlung handelt
    example:

    mime-type: application/json, text/json

    {
    "status": "OK",
    "errors": [
        "Invalid data_type for field 'tarif_id', expected 'string'!"
    ],
    "properties": [
        {
            "type": "INDIVIDUELL",
            "min_selections": 0,
            "max_selections": 3,
            "min_percentage_fonds": 10,
            "max_percentage_fonds": 50
        }
    ],
    "combinations": [
        [
            "INDIVIDUELL",
            "WERTSICHERUNG"
        ],
        [
            "PORTFOLIO",
            "WERTSICHERUNG"
        ]
    ],
    "funds": [
        {
            "tarif_id": "12345",
            "type": "INDIVIDUELL",
            "isin": "DE0008471715",
            "company_fond_id": "AW654654",
            "percent": 100,
            "name": "AL Trust Global Invest",
            "company_name": "ALTE LEIPZIGER Trust Investment-Gesellschaft mbH",
            "category_name": "Aktienfonds All Cap",
            "recommendation": true,
            "characteristics": {
                "is_etf": true,
                "esg_article": 8
            }
        }
    ]
}