get/documents

Ruft die im Tool erstellten Dokumente ab (Dokumentation.zip).

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/get/documents

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/get/documents/request/schema


property default description options
[ token ] * required
string
Token für die Authentifizierung mit der Schnittstelle
[ zip ]
bool
true
Steuert, ob die Dokumente als ZIP oder einzeln zurück gegeben werden sollen.
Bitte beachten Sie: Wird der Wert "false" übergeben, so ändert sich der Response der Schnittstelle!
[ document_types ]
array
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_DATENSCHUTZERKLAERUNG Datenschutzerklärung
DOC_CONSULTING_REPORT Beratungsdokumentation
DOC_PIB Produktinformationsblatt
DOC_XML XML-Antragsinformationen
DOC_JSON JSON-Antragsinformationen
DOC_QR_CODE QR-Code
DOC_SONSTIGE Sonstige Dokumente
DOC_WAIVER_DECLARATION Verzichtserklärung
DOC_PRODUKTEMPFEHLUNG Produktempfehlung
DOC_VERSDIAGNOSE_PROTOCOL Risikoprüfungsprotokoll
DOC_PRODUKTUNTERLAGEN_VERSDIAGNOSE Produktunterlagen aus vers.diagnose (z.B. Fragebögen)
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "zip": true,
    "document_types": [
        "DOC_ANGEBOT",
        "DOC_ANTRAG"
    ]
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9"
}

Response

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

object
Informationen zum Dateiabruf (Rückgabe bei zip=true)
property description options
protocoldata[ mime_type ]
string
MIME-Typ
protocoldata[ buffer ]
string
Buffer
protocoldata[ filename ]
string
Dateiname
protocoldata[ encoded ]
string
Codierung

array
Liste der Dokumente die erzeugt wurden (Rückgabe bei zip=false)
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_DATENSCHUTZERKLAERUNG Datenschutzerklärung
DOC_PRODUKTUNTERLAGEN Produktunterlagen
DOC_CONSULTING_REPORT Beratungsdokumentation
DOC_XML XML-Antragsinformationen
DOC_JSON JSON-Antragsinformationen
DOC_QR_CODE QR-Code
DOC_WAIVER_DECLARATION Verzichtserklärung
DOC_PRODUKTEMPFEHLUNG Produktempfehlung
DOC_VERSDIAGNOSE_PROTOCOL Risikoprüfungsprotokoll
DOC_PRODUKTUNTERLAGEN_VERSDIAGNOSE Produktunterlagen aus vers.diagnose (z.B. Fragebögen)
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_DATENSCHUTZERKLAERUNG Datenschutzerklärung
DOC_PRODUKTUNTERLAGEN Produktunterlagen
DOC_CONSULTING_REPORT Beratungsdokumentation
DOC_XML XML-Antragsinformationen
DOC_JSON JSON-Antragsinformationen
DOC_QR_CODE QR-Code
DOC_WAIVER_DECLARATION Verzichtserklärung
DOC_PRODUKTEMPFEHLUNG Produktempfehlung
DOC_VERSDIAGNOSE_PROTOCOL Risikoprüfungsprotokoll
DOC_PRODUKTUNTERLAGEN_VERSDIAGNOSE Produktunterlagen aus vers.diagnose (z.B. Fragebögen)
documents[ mime_type ]
string
Mime-Type des Dokuments
Value Label
application/pdf PDF
application/json JSON
application/xml XML
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."
    ],
    "protocoldata": {
        "mime_type": "application\/zip",
        "buffer": "AS3RDCFG5HZTFRBHJUZTFRD89SDFBH09NJH4G",
        "filename": "Dokumentation.zip",
        "encoded": "base64"
    },
    "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"
            ]
        }
    ]
}