document/getadditionaldocuments

Ermöglicht das Abrufen statischer Unterlagen.

Bitte beachten Sie, dass die zurück gelieferten URL´s nur Dokumente zum Abrufen bereitstellen, wenn Sie sich im gleichen Sessioncontext bewegen (CookieJar) und sich zuvor an der Schnittstelle mittels "getLoginToken" authentifiziert haben.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/document/getadditionaldocuments

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/document/getadditionaldocuments/request/schema

Validation: POST https://bankathon.fb-xpert.fb-preview.de/external/document/getadditionaldocuments/validate


property default description options
[ token ] * required
string
Token für die Authentifizierung mit der Schnittstelle
[ pkfgs ] * required
array
PKFGs, für die zusätzliche Unterlagen abgerufen werden sollen
[ get_buffer ]
bool
true
Dieses Feld verändert den response. Wird false übergeben, verschwindet das Feld buffer und es wird eine Url zum download der Dokumente übermittelt.
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "pkfgs": [
        123456
    ],
    "get_buffer": "true"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "pkfgs": [
        123456
    ]
}

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/document/getadditionaldocuments/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_type ]
string
primärer Dokumenttyp
Value Label
DOC_PRODUKTUNTERLAGEN Produktunterlagen
documents[ doc_types ]
array
Dokumenttypen
Value Label
DOC_ANTRAG Antrag
DOC_BEDINGUNGEN Bedingungen
DOC_PRODUKTUNTERLAGEN Produktunterlagen
DOC_PRODUKTUNTERLAGEN_VERSDIAGNOSE vers.diagnose Unterlagen (z.B. Fragebögen)
DOC_SONSTIGE sonstige Dokumente
documents[ mime_type ]
string
Mime-Type des Dokuments
Value Label
application/pdf PDF
documents[ filename ]
string
Name des Dokumentes
documents[ modified ]
string
Letztes Änderungsdatum des Dokuments
documents[ buffer ]
string
Codierter String des Dokumentenbuffers
documents[ vvg ]
bool
VVG relevant?
Value Label
true Ja
false Nein
documents[ url ]
string
Absolute Url für den Download des jeweiligen Dokuments. Dieses Feld wird nur übergeben wenn im request get_buffer = false angegeben wird.
documents[ encoded ]
string
Beschreibt wie das Dokument encoded wurde
Value Label
base64 Base64 String
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "documents": [
        {
            "pkfg": "123456",
            "doc_type": "DOC_PRODUKTUNTERLAGEN",
            "doc_types": [
                "DOC_PRODUKTUNTERLAGEN",
                "DOC_BEDINGUNGEN"
            ],
            "mime_type": "application\/pdf",
            "filename": "AntragKurz.pdf",
            "modified": "2017-0-10 00:05:39",
            "buffer": "fsaofo9sda7z89f7sdf897sdp89f7s",
            "vvg": "true",
            "url": "https:\/\/...\/-externaldocuments\/download.do?resource_alias=company_pdfs&name=08be913d23hd49tf86cce029d111edd0.pdf",
            "encoded": "base64"
        }
    ]
}