login/getaccessurl

Liefert als Ergebnis eine URL, mit der man im Tool eingeloggt wird. Man landet dort auf der Startseite nach dem Login.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/login/getaccessurl

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/login/getaccessurl/request/schema

Validation: POST https://bankathon.fb-xpert.fb-preview.de/external/login/getaccessurl/validate


property default description options
[ user_name ] * required
string
Ihr Benutzername
[ password ] * required
string
Ihr Passwort
[ user_addition ]
string
Suffix zur Erweiterung des Benutzernamens für den Trichterlogin
[ separate_token ]
bool
false
Steuert, ob der Token als separates Feld zurückgegeben wird oder in der aufzurufenden Url enthalten ist. Standardmäßig wird er in der Url zurückgegeben.

object
Vorgangsinformationen
property default description options
transaction[ transaction_id_partner ]
string
Vorgangsnummer des aufrufenden Systems

array
Vermittlernummern je Gesellschaft
property default description options
company_agent_ids[ company_id ]
int
Gesellschafts ID
company_agent_ids[ bafin_nr ] * required
int
Bafin Register Nr.
company_agent_ids[ agent_id ] * required
string
Vermittlernummer
company_agent_ids[ description ]
string
Infotext

object
Vermittlerdaten für den Trichterlogin
property default description options
brokerdata[ agency_number ]
string
Agentur-Vermittlernummer
brokerdata[ salutation ] * required
enumeration
Anrede
Value Label
Firma Firma
Herr Herr
Frau Frau
Sonstige Sonstige
brokerdata[ title ]
string
Titel
brokerdata[ first_name ] * required
string
Vorname
brokerdata[ last_name ] * required
string
Nachname
brokerdata[ company_name ] * required
string
Firmenbezeichnung
* required
object
Adressdaten
property default description options
address[ street ] * required
string
Straße
Wird die Hausnummer bei der Straße übermittelt, wird versucht, diese herauszulösen und in "street_number" umzuleiten!
address[ street_number ]
string
Hausnummer
address[ zip_code ]
string
Postleitzahl
address[ city ] * required
string
Ort
Wird die Postleitzahl im Ort übermittelt, wird versucht, diese herauszulösen und in "zip_code" umzuleiten!

object
Kontaktdaten
property default description options
communication[ email ] * required
string
E-Mail
communication[ www ]
string
Internetpräsenz

array
Telefonnummern
property default description options
numbers[ art ] * required
enumeration
Art der Telefonnummer
Value Label
Telefon Telefon
Telefax Telefax
Mobilfunk Mobilfunk
numbers[ area_code ]
string
Ortsvorwahl
numbers[ number ] * required
string
Rufnummer
Wird die Vorwahl bei der Rufnummer übermittelt, wird versucht, diese herauszulösen und in "area_code" umzuleiten!

object
Daten zur IHK
property default description options
ihk[ registration_number ]
string
Registriernummer
ihk[ reason_for_no_registrationnumber ]
string
Angabe, warum keine Registriernummer vorhanden ist
ihk[ name ]
string
Name
ihk[ street ]
string
Straße
ihk[ street_number ]
string
Hausnummer
ihk[ zip_code ]
string
Postleitzahl
ihk[ city ]
string
Ort

object
Kontaktdaten
property default description options
communication[ email ] * required
string
E-Mail
communication[ www ]
string
Internetpräsenz

array
Telefonnummern
property default description options
numbers[ art ] * required
enumeration
Art der Telefonnummer
Value Label
Telefon Telefon
Telefax Telefax
Mobilfunk Mobilfunk
numbers[ area_code ]
string
Ortsvorwahl
numbers[ number ] * required
string
Rufnummer
Wird die Vorwahl bei der Rufnummer übermittelt, wird versucht, diese herauszulösen und in "area_code" umzuleiten!
brokerdata[ broker_status ]
enumeration
Status des Vermittlers
Value Label
MAKLER_MIT_ERLAUBNIS_34D_1_GEWO Versicherungsmakler mit einer Erlaubnis nach §34d Abs. 1 der Gewerbeordnung.
MAKLER_MIT_ERLAUBNISBEFREIUNG_34D_3_GEWO Versicherungsmakler mit Erlaubnisbefreiung nach §34d Abs. 6 der Gewerbeordnung als produktakzessorischer Versicherungsmakler.
VERTRETER_MIT_ERLAUBNIS_34D_1_GEWO Versicherungsvertreter mit einer Erlaubnis nach §34d Abs. 1 der Gewerbeordnung.
VERTRETER_GEBUNDEN_34D_4_GEWO Gebundener Versicherungsvertreter nach §34d Abs. 7 Satz 1 Nummer 1 der Gewerbeordnung.
VERTRETER_MIT_ERLAUBNISBEFREIUNG_34D_3_GEWO Versicherungsvertreter mit Erlaubnisbefreiung nach §34d Abs. 6 der Gewerbeordnung als produktakzessorischer Versicherungsvertreter.
BERATER_MIT_ERLAUBNIS_34E_1_GEWO Versicherungsberater mit einer Erlaubnis nach §34d Abs. 2 der Gewerbeordnung.
brokerdata[ participation_in_companies ]
enumeration
Beteiligung an Versicherungsunternehmen
Value Label
WENIGER_10_PROZENT Der Vermittler hält keine unmittelbare oder mittelbare Beteiligung von mehr als 10% der Stimmrechte oder des Kapitals an Versicherungsunternehmen.
MEHR_10_PROZENT Der Vermittler hält unmittelbare oder mittelbare Beteiligung von mehr als 10% der Stimmrechte oder des Kapitals an folgenden Versicherungsunternehmen:
brokerdata[ participation_in_company_names ]
string
Beteiligung / Stimmrecht an folgenden Versicherungsunternehmen
brokerdata[ involved_companies ]
enumeration
Beteiligte Versicherungsunternehmen
Value Label
WENIGER_10_PROZENT Kein Versicherungsunternehmen hält unmittelbare oder mittelbare Beteiligung von mehr als 10% der Stimmrechte oder des Kapitals am Versicherungsvermittler.
MEHR_10_PROZENT Folgende Versicherungsunternehmen halten unmittelbare oder mittelbare Beteiligung von mehr als 10% der Stimmrechte oder des Kapitals am Versicherungsvermittler:
brokerdata[ involved_company_names ]
string
Beteiligte Versicherungsunternehmen

object
Vermögensschadenhaftpflicht
property default description options
vermoegensschadenhaftpflicht[ available ]
enumeration
false
Der Vermittler unterhält eine Vermögensschadenshaftpflicht, die den gesetzlichen Anforderungen gemäß §§ 8 und 9 der Versicherungsvermittlungsverordnung i.V.m. § 34d Abs. 2 Nr. 3 der Gewerbeordnung entspricht.
Value Label
false nein
true ja
vermoegensschadenhaftpflicht[ policy_number ]
string
Versicherungsnummer
vermoegensschadenhaftpflicht[ sum_insured_per_damage ]
string
Versicherungssumme pro Schadensfall
vermoegensschadenhaftpflicht[ sum_insured_per_year ]
string
Versicherungssumme pro Jahr
vermoegensschadenhaftpflicht[ stand ]
string
Stand
vermoegensschadenhaftpflicht[ company ]
string
Versicherungsgesellschaft
vermoegensschadenhaftpflicht[ policy_owner ]
string
Versicherungsnehmer

array
Rahmenvertragsnummer je Gesellschaft
property default description options
company_agreement_ids[ bafin_nr ] * required
int
Bafin Register Nr.
company_agreement_ids[ agreement_id ] * required
string
Rahmenvertragsnummer

object
Daten zur Onlinebeantragung
property default description options

array
E-Mail Empfänger je Gesellschaft
property default description options
recipients[ bafin_nr ] * required
int
Bafin Register Nr.
recipients[ email_to ] * required
string
E-Mail Adresse, an welche der Antrag bei der Gesellschaft gesendet werden soll.
brokerdata[ office_id ]
string
Büronummer
[ exit_url ]
string
URL, welche beim Verlassen des Tools per Redirect (HTTP 302) aufgerufen wird.
[ keep_alive_url ]
string
URL zur Sessionverlängerung in einem externen System (Browserseitiger CrossSite GET-Request).
example:

mime-type: application/json, text/json

{
    "user_name": "Mainuser",
    "password": "geheim123",
    "user_addition": "Subuser123",
    "separate_token": true,
    "transaction": {
        "transaction_id_partner": "afa777d85054a86bdd67876e607374a28d12c844"
    },
    "company_agent_ids": [
        {
            "bafin_nr": 4711,
            "agent_id": "123456789",
            "description": "Niedrige Provision"
        }
    ],
    "brokerdata": {
        "agency_number": "12345-789",
        "salutation": "Herr",
        "title": "Dr.",
        "first_name": "Muster",
        "last_name": "Vermittler",
        "company_name": "Super Vermittler GmbH",
        "address": {
            "street": "Musterstraße",
            "street_number": "123a",
            "zip_code": "30159",
            "city": "Hannover"
        },
        "communication": {
            "email": "vermitter@fb-research.de",
            "www": "https:\/\/www.fb-research.de",
            "numbers": [
                {
                    "art": "Telefon",
                    "area_code": "0511",
                    "number": "123456789"
                }
            ]
        },
        "ihk": {
            "registration_number": "D-XXXX-XXXXX-XX",
            "reason_for_no_registrationnumber": "",
            "name": "IHK Musterhausen",
            "street": "Musterstraße",
            "street_number": "123a",
            "zip_code": "30159",
            "city": "Hannover",
            "communication": {
                "email": "vermitter@fb-research.de",
                "www": "https:\/\/www.fb-research.de",
                "numbers": [
                    {
                        "art": "Telefon",
                        "area_code": "0511",
                        "number": "123456789"
                    }
                ]
            }
        },
        "broker_status": "MAKLER_MIT_ERLAUBNIS_34D_1_GEWO",
        "participation_in_companies": "MEHR_10_PROZENT",
        "participation_in_company_names": "Pfefferminzia, ...",
        "involved_companies": "WENIGER_10_PROZENT",
        "involved_company_names": "Pfefferminzia, ...",
        "vermoegensschadenhaftpflicht": {
            "available": "true",
            "policy_number": "95491694654-465465418",
            "sum_insured_per_damage": "300000",
            "sum_insured_per_year": "600000",
            "stand": "01.01.2018",
            "company": "Muster VU",
            "policy_owner": "Max Mustermann"
        },
        "company_agreement_ids": [
            {
                "bafin_nr": 4711,
                "agreement_id": "123456789"
            }
        ],
        "onlineoffer": {
            "recipients": [
                {
                    "bafin_nr": 4711,
                    "email_to": "antrag@gesellschaft.de"
                }
            ]
        },
        "office_id": "12345"
    },
    "exit_url": "https:\/\/www.external-target.com\/",
    "keep_alive_url": "https:\/\/www.xyz.de\/session_keepalive..."
}
example:

mime-type: application/json, text/json

{
    "user_name": "Mainuser",
    "password": "geheim123"
}

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/login/getaccessurl/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!
[ accessurl ]
string
aufzurufende URL
[ token ]
string
Token zur Authentifizierung
[ loggedin ]
bool
Status des Logins
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "accessurl": "https:\/\/Toolname.de\/Bereich\/index.php?token=...",
    "token": "0123456789abcdefghijklmnop",
    "loggedin": true
}