onlineoffer/getdocuments

Gibt die erzeugten Dokumente aus der Onlinebeantragung zurück.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/onlineoffer/getdocuments

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/onlineoffer/getdocuments/request/schema

Validation: POST https://bankathon.fb-xpert.fb-preview.de/external/onlineoffer/getdocuments/validate


property default description options
[ token ] * required
string
Ein gültiger Token für die Authentifizierung mit der Schnittstelle.
[ buffer ]
bool
true
Dieses Feld steuert, ob der Buffer des Dokumentes ausgeliefert werden soll. Bei Wert "false" werden ausschließlich die MetaDaten ausgeliefert!

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/onlineoffer/getdocuments/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!

array
Liste der Dokumente die erzeugt wurden.
property description options
documents[ pkfg ]
string
PKFG des Produktes
documents[ doc_types ]
array
Dokumenttypen
Value Label
DOC_BEDINGUNGEN Bedingungen
DOC_ANGEBOT Angebot (kurz)
DOC_ANTRAG Antrag (kurz)
DOC_ANGEBOTSMODELL Angebotsmodell
DOC_ANTRAGSMODELL Antragsmodell
DOC_SEPA_MANDAT SEPA-Mandat
DOC_QR_CODE QR-Code
documents[ doc_type ]
string
primärer Dokumenttyp
Value Label
DOC_BEDINGUNGEN Bedingungen
DOC_ANGEBOT Angebot (kurz)
DOC_ANTRAG Antrag (kurz)
DOC_ANGEBOTSMODELL Angebotsmodell
DOC_ANTRAGSMODELL Antragsmodell
DOC_SEPA_MANDAT SEPA-Mandat
DOC_QR_CODE QR-Code
documents[ mime_type ]
string
Mime-Type des Dokuments
Value Label
application/pdf PDF
documents[ filename ]
string
Name des Dokumentes
documents[ buffer ]
string
Codierter String des Dokumentenbuffers
documents[ error ]
array
Aufgetretene Fehler bei der Dokumentenerstellung
documents[ info ]
array
Hinweise die bei der Dokumentenerstellung aufgetreten sind
documents[ encoded ]
string
Beschreibt wie das Dokument encoded wurde
Value Label
base64 Base64 String
documents[ tags ]
array
Besondere Kennzeichen zur identifizierung der Dokumente.
Value Label
AVV_COMPLETED Vollständige Unterlage (AVV Prozess)
NEED_SIGN Benötigt für den setOrder Prozess eine Unterschrift
PROTECTED Dokumentenschutz vorhanden
SIGNED Dokument wurde digital unterschrieben
UPLOADED Dokument wurde im Tool hochgeladen
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "documents": [
        {
            "pkfg": "123456",
            "doc_types": [
                "DOC_ANGEBOTSMODELL",
                "DOC_ANTRAGSMODELL"
            ],
            "doc_type": "DOC_ANTRAGSMODELL",
            "mime_type": "application\/pdf",
            "filename": "AntragKurz.pdf",
            "buffer": "fsaofo9sda7z89f7sdf897sdp89f7s",
            "error": [
                "Ein Selbstbehalt von 150 Euro wird vom Produkt nicht unterstützt."
            ],
            "info": [
                "Es wurde ein Rabatt berücksichtigt."
            ],
            "encoded": "base64",
            "tags": [
                "COMPLETED",
                "NEED_SIGN",
                "SIGNED"
            ]
        }
    ]
}